Преглед

Ендпоинти

Секој ендпоинт е под еден основен URL и се услужува преку HTTPS.

https://api.shannon-ai.com

Трите ендпоинти што создаваат текст стигнуваат до истите модели. Изберете го оној чиј формат го користи вашиот код.

Основи на барањето

• Телото на секој POST е еден JSON објект, до 32 MiB.
• Поле што API-то не го познава не предизвикува грешка и нема ефект. Барање напишано за друг провајдер не пропаѓа поради вишок поле.
• Познато поле со погрешен JSON тип, или недостасувачко задолжително поле, се одговара со 422. Тело што не е валиден JSON се одговара со 400.
• model е еден од идовите на Модели и цени. Големите и малите букви не се важни.

Одговорот е JSON, или streaming од server-sent events кога барањето го поставува stream на true. Секој ендпоинт одговара во свој формат. Секој одговор го има header-от x-request-id.

Низ што поминува барањето

Барањето се проверува по фиксен редослед пред да се изврши моделот. Одговара првата проверка што ќе падне, па 401 сè уште не ви кажува ништо за телото.

Облик на грешка

Грешката е JSON објект со error што ги содржи type и message. /v1/messages го завиткува онака како што го очекуваат SDK-ата на Anthropic; секоја друга патека го користи обликот на OpenAI.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• Прочитајте type и message. code и param постојат само кај некои грешки: третирајте ги како изборни. param е секогаш null.
• Откако streaming-от ќе започне, статусот е веќе 200. Неуспехот тогаш пристигнува како фрејм за грешка во streaming-от.
• Секој одговор со грешка го содржи header-от x-request-id.

Ракување со грешки

Наплата и салдо

• Постои едно салдо по сметка, а разговорот и API-то го делат: најпрво денешниот лимит на планот, потоа купениот кредит. API-то нема своја квота.
• Барањето го резервира својот излезен буџет (max_tokens, стандардно 4,096) и потоа се наплатува за токените што навистина ги искористило, по цената на моделот.
• Секој одговор ги пријавува своите бројки на токени во usage. Страницата Клучеви и употреба го прикажува салдото и колку чинело секое барање.
• Секое барање се услужува еднакво. Единственото ограничување на стапката на барања е flood protection: 120 барања во минута по сметка. Барањата испратени паралелно чекаат во ред.

Ограничувања и салдо Модели и цени Клучеви и употреба

Полиња што зависат од моделот

Секој модел го прима истото барање. Некои полиња имаат ефект само на одредени модели; табелата кажува каде. Страниците на ендпоинтите ги наведуваат сите полиња.

Chat Completions

Доаѓате од SDK на OpenAI

• Поставете го основниот URL на https://api.shannon-ai.com/v1, а клучот на вашиот клуч за Shannon. Повиците на Chat Completions и Responses потоа работат со SDK-то каков што е.
• model мора да биде Shannon ид. Име на модел од друг провајдер, како gpt-4o, се одговара со 400 и unknown model.
• Размислувањето доаѓа во посебно поле: reasoning_content покрај content, во пораката и во delta-ите на streaming-от.
• Streaming секогаш носи usage во својот последен chunk, заедно со finish_reason.
• Повикот на алатка во streaming пристигнува како еден chunk со целиот стринг arguments.
• Одговорот има еден choice.
• Патеки од API-то на OpenAI што не се во табелата погоре, како /v1/embeddings, се одговараат со 404.

Доаѓате од SDK на Anthropic

• Поставете го основниот URL на https://api.shannon-ai.com, без /v1, а клучот на вашиот клуч за Shannon. SDK-то го испраќа како x-api-key.
• model мора да биде Shannon ид.
• max_tokens е изборен на ова API. Стандардната вредност е 4,096.
• Одговорот содржи блокови содржина од тип thinking, text и tool_use. Првиот блок не е секогаш текстот: избирајте блокови според type.
• stop_reason е end_turn или tool_use. Streaming на модел Shannon може да заврши и со max_tokens.
• anthropic-version и anthropic-beta се прифаќаат, па SDK-то работи непроменето. Барањето не ги бара.
• Грешките на /v1/messages имаат облик на Anthropic: {"type": "error", "error": {…}}.

Алатките за програмирање што го зборуваат овој формат се поставуваат на ист начин: основен URL, клуч и Shannon ид како модел. CLI алатки за програмирање