Pregled

Končne točke

Vsaka končna točka je pod enim osnovnim URL-jem in se streže prek HTTPS.

https://api.shannon-ai.com

Tri končne točke, ki ustvarjajo besedilo, dosegajo iste modele. Izberite tisto, katere format koda že uporablja.

Osnove zahtevkov

• Telo vsakega POST je en objekt JSON, velik do 32 MiB.
• Polje, ki ga API ne pozna, ne povzroči napake in nima učinka. Zahtevek, napisan za drugega ponudnika, zaradi dodatnega polja ne odpove.
• Na znano polje z napačnim tipom JSON ali manjkajoče obvezno polje se odgovori z 422. Na telo, ki ni veljaven JSON, se odgovori z 400.
• model je eden od id na strani Models & pricing. Velike in male črke niso pomembne.

Odgovor je JSON ali tok dogodkov, ki jih pošilja strežnik (server-sent events), kadar zahtevek nastavi stream na true. Vsaka končna točka odgovarja v svojem formatu. Vsak odgovor ima glavo x-request-id.

Kaj zahtevek mora prestati

Zahtevek se pred zagonom modela preveri v stalnem vrstnem redu. Odgovori prvo preverjanje, ki ne uspe, zato vam 401 o telesu še ne pove ničesar.

Oblika napake

Napaka je objekt JSON z error, ki vsebuje type in message. /v1/messages ga ovije tako, kot ga pričakujejo SDK-ji Anthropic; vsaka druga pot uporablja obliko OpenAI.

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

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

• Preberite type in message. code in param sta prisotna samo pri nekaterih napakah: obravnavajte ju kot neobvezna. param je vedno null.
• Ko se tok začne, je status že 200. Napaka nato prispe kot okvir napake znotraj toka.
• Vsak odgovor z napako vsebuje glavo x-request-id.

Obravnava napak

Obračun in stanje

• Na račun je eno stanje, klepet in API pa ga delita: najprej današnja dnevna kvota paketa, nato kupljeni kredit. API nima lastne kvote.
• Zahtevek rezervira svoj izhodni proračun (max_tokens, privzeto 4,096) in mu je nato obračunano toliko tokenov, kolikor jih je res porabil, po ceni modela.
• Vsak odgovor v usage sporoča števila tokenov. Stran Ključi in poraba prikazuje stanje in strošek vsakega zahtevka.
• Vsak zahtevek se obravnava enako. Edina omejitev hitrosti zahtevkov je zaščita pred poplavo: 120 zahtevkov na minuto na račun. Zahtevki, poslani vzporedno, čakajo v vrsti.

Omejitve in stanje Modeli in cene Ključi in poraba

Polja, ki so odvisna od modela

Vsak model sprejme isti zahtevek. Nekaj polj učinkuje samo pri nekaterih modelih; tabela navaja, pri katerih. Strani s končnimi točkami navajajo vsa polja.

Chat Completions

Če prihajate iz SDK-ja OpenAI

• Osnovni URL nastavite na https://api.shannon-ai.com/v1, ključ pa na svoj ključ Shannon. Klici Chat Completions in Responses nato z SDK delujejo takoj.
• model mora biti id Shannon. Na ime modela drugega ponudnika, na primer gpt-4o, se odgovori z 400 in unknown model.
• Razmišljanje pride v lastnem polju: reasoning_content ob content, v sporočilu in v delta kosih toka.
• Tok vedno nosi usage v zadnjem kosu, skupaj s finish_reason.
• Klic orodja v toku prispe kot en kos s popolnim nizom arguments.
• Odgovor ima eno izbiro (choice).
• Na poti API-ja OpenAI, ki jih ni v zgornji tabeli, na primer /v1/embeddings, se odgovori z 404.

Če prihajate iz SDK-ja Anthropic

• Osnovni URL nastavite na https://api.shannon-ai.com, brez /v1, ključ pa na svoj ključ Shannon. SDK ga pošlje kot x-api-key.
• model mora biti id Shannon.
• max_tokens je pri tem API-ju neobvezen. Privzeto je 4,096.
• Odgovor vsebuje bloke vsebine tipov thinking, text in tool_use. Prvi blok ni vedno besedilo: bloke izbirajte po type.
• stop_reason je end_turn ali tool_use. Tok modela Shannon se lahko konča tudi z max_tokens.
• anthropic-version in anthropic-beta sta sprejeta, zato SDK deluje nespremenjen. Zahtevek ju ne potrebuje.
• Napake na /v1/messages imajo obliko Anthropic: {"type": "error", "error": {…}}.

Orodja za programiranje, ki govorijo te formate, se nastavijo enako: osnovni URL, ključ in id Shannon kot model. Orodja CLI za programiranje