Preskoči na sadržaj
Pregled

Pregled

Mapa API-ja: svaki endpoint, kako izgledaju zahtjev i greška, kako se pozivi plaćaju i šta trebate znati ako dolazite iz OpenAI ili Anthropic SDK-a.

Endpointi

Svaki endpoint nalazi se pod jednim osnovnim URL-om i opslužuje se preko HTTPS-a.

Osnovni URL
https://api.shannon-ai.com
Endpoint Format Čemu služi
POST /v1/chat/completions OpenAI Chat Completions Pošaljite razgovor, dobijte sljedeći odgovor. Sa streamingom ili bez.
POST /v1/messages Anthropic Messages Isto, u oblicima zahtjeva i odgovora Anthropic SDK-ova.
POST /v1/responses OpenAI Responses Isto, u oblicima Responses. Endpoint ne čuva stanje: šaljite razgovor sa svakim zahtjevom.
GET /v1/models OpenAI lista modela Navedite modele s kontekstnim prozorom, cijenama i mogućnostima. Ne treba ključ.
POST /v1/tokenize Shannon API Izbrojite tokene teksta ili chat zahtjeva za hostirani open-weight model. Besplatno.
POST /v1/messages/count_tokens Anthropic brojanje tokena Izbrojite ulazne tokene zahtjeva Messages za hostirani open-weight model. Besplatno.

Tri endpointa koja proizvode tekst dosežu iste modele. Izaberite onaj čiji format vaš kod već koristi.

Osnove zahtjeva

Zaglavlje Opis
Authorization: Bearer <key> Vaš API ključ. Obavezno na svakom endpointu osim GET /v1/models, osim ako šaljete x-api-key.
x-api-key: <key> Isti ključ u zaglavlju koje šalju Anthropic SDK-ovi. Čita se na svakom endpointu.
Content-Type: application/json Obavezno na svakom POST-u. Bez njega je odgovor 415.
x-request-id: <your id> Opcionalno. Vaš vlastiti id zahtjeva; vraća se u zaglavlju odgovora x-request-id. Bez njega API kreira id od 12 heksadecimalnih znakova.
  • Tijelo svakog POST-a je jedan JSON objekat, do 32 MiB.
  • Polje koje API ne poznaje ne uzrokuje grešku i nema učinka. Zahtjev napisan za drugog provajdera ne propada zbog viška polja.
  • Na poznato polje s pogrešnim JSON tipom, ili na nedostajuće obavezno polje, odgovara se sa 422. Na tijelo koje nije valjan JSON odgovara se sa 400.
  • model je jedan od id-ova na stranici Modeli i cijene. Velika i mala slova nisu bitna.

Odgovor je JSON, ili stream server-sent events kada zahtjev postavi stream na true. Svaki endpoint odgovara u svom formatu. Svaki odgovor ima zaglavlje x-request-id.

Šta zahtjev prolazi

Zahtjev se provjerava utvrđenim redoslijedom prije nego što se model pokrene. Odgovara prva provjera koja ne uspije, pa vam 401 još ništa ne govori o tijelu.

Oblik greške

Greška je JSON objekat s error koji sadrži type i message. /v1/messages ga umotava onako kako Anthropic SDK-ovi očekuju; svaka druga putanja koristi OpenAI oblik.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}
  • Čitajte type i message. code i param postoje samo kod nekih grešaka: tretirajte ih kao opcionalne. param je uvijek null.
  • Nakon što je stream počeo, status je već 200. Greška tada stiže kao error frame unutar streama.
  • Svaki odgovor s greškom nosi zaglavlje x-request-id.
Status Tip Kada
400 invalid_request_error Tijelo nije valjan JSON, id modela je nepoznat, ili model ne prima vrstu ulaza koju ste poslali.
401 authentication_error Ključ nedostaje ili nije valjan.
404 not_found_error Putanja ne postoji.
405 api_error Putanja postoji, metoda je pogrešna.
413 invalid_request_error Tijelo je veće od 32 MiB.
415 invalid_request_error Content-Type nije application/json.
422 invalid_request_error Polje ima pogrešan JSON tip ili nedostaje obavezno polje.
429 rate_limit_error Stanje ne pokriva zahtjev, u minuti je stiglo više od 120 zahtjeva, Shannon Coder pozivi iz prozora su potrošeni, ili je model zauzet. Poruka kaže koji je slučaj.
5xx api_error Status 500, 502, 503 ili 504: zahtjev je bio valjan i na njega se nije moglo odgovoriti. Pošaljite ga ponovo. 500 može nositi tip server_error.

Upravljanje greškama

Naplata i stanje

  • Postoji jedno stanje po računu, a chat i API ga dijele: prvo današnja dnevna kvota plana, zatim kupljeni kredit. API nema vlastitu kvotu.
  • Zahtjev rezerviše svoj izlazni budžet (max_tokens, zadano 4,096), a zatim se naplaćuje za tokene koje je zaista iskoristio, po cijeni modela.
  • Svaki odgovor prijavljuje broj svojih tokena u usage. Stranica Ključevi i korištenje prikazuje stanje i koliko je koštao svaki zahtjev.
  • Svaki zahtjev se opslužuje jednako. Jedino ograničenje brzine zahtjeva je flood zaštita: 120 zahtjeva u minuti po računu. Zahtjevi poslani paralelno čekaju u redu.

Ograničenja i stanje Modeli i cijene Ključevi i korištenje

Polja koja ovise o modelu

Svaki model prima isti zahtjev. Nekoliko polja djeluje samo na nekim modelima; tabela navodi gdje. Stranice endpointa navode svako polje.

Polje Opis Primjenjuje
system Upute za model: poruka system na Chat Completions, system na Messages, instructions na Responses. Hostirani open-weight modeli, shannon-1.6-*, shannon-2-*, shannon-coder-1
temperature Temperatura uzorkovanja. Hostirani open-weight modeli, shannon-1.6-*, shannon-coder-1
top_p Nucleus uzorkovanje. Hostirani open-weight modeli
seed Fiksni seed za uzorkovanje. Hostirani open-weight modeli
stop Do 4 stop sekvence. Hostirani open-weight modeli
reasoning_effort Koliko model razmišlja prije nego što odgovori. reasoning.effort na Responses, thinking na Messages. Hostirani open-weight modeli
web_search true omogućava modelu da za ovaj zahtjev pretražuje web. Polje ovog API-ja, na Chat Completions i Messages. Shannon modeli osim shannon-coder-1
max_tokens Izlazni budžet. Na svakom modelu određuje iznos rezervisan sa vašeg stanja. Kao ograničenje dužine odgovora: hostirani open-weight modeli, shannon-1.6-*, shannon-coder-1

Chat Completions

Dolazite iz OpenAI SDK-a

  • Postavite osnovni URL na https://api.shannon-ai.com/v1, a ključ na svoj Shannon ključ. Pozivi Chat Completions i Responses tada rade sa SDK-om bez izmjena.
  • model mora biti Shannon id. Na ime modela drugog provajdera, kao što je gpt-4o, odgovara se sa 400 i unknown model.
  • Razmišljanje dolazi u zasebnom polju: reasoning_content pored content, u poruci i u delta objektima streama.
  • Stream uvijek nosi usage u svom posljednjem chunku, zajedno s finish_reason.
  • Poziv alata u streamu stiže kao jedan chunk s kompletnim stringom arguments.
  • Odgovor ima jedan izbor.
  • Na putanje OpenAI API-ja koje nisu u tabeli iznad, kao što je /v1/embeddings, odgovara se sa 404.

Dolazite iz Anthropic SDK-a

  • Postavite osnovni URL na https://api.shannon-ai.com, bez /v1, a ključ na svoj Shannon ključ. SDK ga šalje kao x-api-key.
  • model mora biti Shannon id.
  • max_tokens je u ovom API-ju opcionalan. Zadano je 4,096.
  • Odgovor sadrži blokove sadržaja tipa thinking, text i tool_use. Prvi blok nije uvijek tekst: blokove birajte po type.
  • stop_reason je end_turn ili tool_use. Stream Shannon modela može završiti i s max_tokens.
  • anthropic-version i anthropic-beta se prihvataju, pa SDK radi neizmijenjen. Zahtjev ih ne treba.
  • Greške na /v1/messages imaju Anthropic oblik: {"type": "error", "error": {…}}.

Alati za kodiranje koji govore ove formate postavljaju se na isti način: osnovni URL, ključ i Shannon id kao model. CLI alati za kodiranje