Ikuspegi orokorra

Endpoint-ak

Endpoint guztiak base URL bakar baten azpian daude eta HTTPS bidez zerbitzatzen dira.

https://api.shannon-ai.com

Testua sortzen duten hiru endpoint-ek modelo berberetara iristen dira. Aukeratu zure kodeak jada erabiltzen duen formatukoa.

Eskaeren oinarriak

• Edozein POST-en gorputza JSON objektu bakar bat da, 32 MiB arte.
• APIak ezagutzen ez duen eremu batek ez du errorerik eragiten eta ez du eraginik. Beste hornitzaile baterako idatzitako eskaerak ez du huts egiten eremu gehigarri batengatik.
• JSON mota okerra duen eremu ezagun bati, edo beharrezko eremu falta bati, 422 erantzuten zaio. JSON baliodun ez den gorputz bati 400 erantzuten zaio.
• model Modeloak eta prezioak orrialdeko id-etako bat da. Maiuskulek eta minuskulek ez dute axolarik.

Erantzuna JSON da, edo server-sent events stream bat eskaerak stream true gisa ezartzen duenean. Endpoint bakoitzak bere formatuan erantzuten du. Erantzun guztiek x-request-id goiburua dute.

Eskaera batek zer gainditzen duen

Eskaera bat ordena finko batean egiaztatzen da modeloa exekutatu aurretik. Huts egiten duen lehen egiaztapenak erantzuten du, beraz 401 batek ez dizu oraindik ezer esaten gorputzari buruz.

Errore-forma

Errore bat type eta message dituen error bat duen JSON objektu bat da. /v1/messages-ek Anthropic SDK-ek espero duten moduan biltzen du; beste bide guztiek OpenAI forma erabiltzen dute.

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

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

• Irakurri type eta message. code eta param errore batzuetan bakarrik daude: hartu aukerakotzat. param beti null da.
• Stream bat hasi ondoren egoera 200 da jada. Hutsegite bat orduan streamaren barruko errore-frame gisa iristen da.
• Errore-erantzun guztiek x-request-id goiburua dute.

Errore‑kudeaketa

Fakturazioa eta saldoa

• Kontu bakoitzeko saldo bakarra dago, eta txatak eta API-ak partekatzen dute: lehenik gaurko planaren kupoa, gero erositako kreditua. APIak ez du kupo propiorik.
• Eskaera batek bere irteera-aurrekontua erreserbatzen du (max_tokens, lehenetsia 4,096) eta gero benetan erabilitako tokenengatik kobratzen da, modeloaren prezioan.
• Erantzun bakoitzak bere token-kontaketak jakinarazten ditu usage-n. Gakoak eta erabilera orrialdeak saldoa eta eskaera bakoitzak zenbat kostatu duen erakusten du.
• Eskaera guztiak berdin zerbitzatzen dira. Eskaera-tasaren gaineko muga bakarra flood protection da: minutuko 120 eskaera kontu bakoitzeko. Paraleloan bidalitako eskaerak ilaran itxaroten dute.

Mugak eta saldoa Modeloak eta prezioak Gakoak eta erabilera

Modeloaren araberako eremuak

Modelo guztiek eskaera bera hartzen dute. Eremu batzuek modelo batzuetan bakarrik dute eragina; taulak non adierazten du. Endpoint-orrialdeek eremu guztiak zerrendatzen dituzte.

Chat Completions

OpenAI SDK batetik zatoz

• Ezarri base URL-a https://api.shannon-ai.com/v1 gisa eta gakoa zure Shannon gako gisa. Chat Completions eta Responses deiek orduan SDK-arekin funtzionatzen dute dagoen bezala.
• model Shannon id bat izan behar da. Beste hornitzaile baten modelo-izen bati, adibidez gpt-4o, 400 eta unknown model erantzuten zaio.
• Arrazonamendua eremu propio batean dator: reasoning_content content-en ondoan, mezuan eta stream-deltetan.
• Stream batek beti usage darama azken chunk-ean, finish_reason-ekin batera.
• Stream bateko tresna-dei bat chunk bakar gisa iristen da, arguments kate osoarekin.
• Erantzun batek aukera bakarra du.
• OpenAI APIaren goiko taulan ez dauden bideei, hala nola /v1/embeddings, 404 erantzuten zaie.

Anthropic SDK batetik zatoz

• Ezarri base URL-a https://api.shannon-ai.com gisa, /v1 gabe, eta gakoa zure Shannon gako gisa. SDK-ak x-api-key gisa bidaltzen du.
• model Shannon id bat izan behar da.
• max_tokens aukerakoa da API honetan. Lehenetsia 4,096 da.
• Erantzun batek thinking, text eta tool_use motako eduki-blokeak ditu. Lehen blokea ez da beti testua: aukeratu blokeak type bidez.
• stop_reason end_turn edo tool_use da. Shannon modelo baten stream batek max_tokens-ekin ere amaitu daiteke.
• anthropic-version eta anthropic-beta onartzen dira, SDK-a aldatu gabe funtzionatzeko. Eskaera batek ez ditu behar.
• /v1/messages endpoint-eko erroreek Anthropic forma dute: {"type": "error", "error": {…}}.

Formatu hauekin hitz egiten duten programazio-tresnak modu berean konfiguratzen dira: base URL-a, gakoa eta Shannon id bat modelo gisa. Programatzeko CLI tresnak