Pārskats

Galapunkti

Katrs galapunkts atrodas zem viena bāzes URL un tiek apkalpots pa HTTPS.

https://api.shannon-ai.com

Trīs galapunkti, kas veido tekstu, sasniedz tos pašus modeļus. Izvēlieties to, kura formātu jūsu kods jau izmanto.

Pieprasījumu pamati

• Katra POST pamatteksts ir viens JSON objekts, līdz 32 MiB.
• Lauks, ko API nepazīst, neizraisa kļūdu un neko neietekmē. Pieprasījums, kas rakstīts citam pakalpojumu sniedzējam, neizgāžas lieka lauka dēļ.
• Uz zināmu lauku ar nepareizu JSON tipu vai trūkstošu obligātu lauku atbild ar 422. Uz pamattekstu, kas nav derīgs JSON, atbild ar 400.
• model ir viens no id lapā Modeļi un cenas. Lielie un mazie burti nav svarīgi.

Atbilde ir JSON vai servera sūtīto notikumu straume, ja pieprasījums iestata stream uz true. Katrs galapunkts atbild savā formātā. Katrai atbildei ir galvene x-request-id.

Ko pieprasījums iziet

Pirms modeļa darbības pieprasījums tiek pārbaudīts noteiktā secībā. Atbild pirmā pārbaude, kas neizdodas, tāpēc 401 vēl neko nestāsta par pamattekstu.

Kļūdas forma

Kļūda ir JSON objekts ar error, kas satur type un message. /v1/messages to ietin tā, kā to gaida Anthropic SDK; visi pārējie ceļi izmanto OpenAI formu.

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

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

• Lasiet type un message. code un param ir tikai dažām kļūdām: uzskatiet tos par neobligātiem. param vienmēr ir null.
• Pēc straumes sākuma statuss jau ir 200. Tad kļūme ierodas kā kļūdas kadrs straumes iekšienē.
• Katra kļūdas atbilde nes galveni x-request-id.

Kļūdu apstrāde

Apstrāde un atlikums

• Katram kontam ir viens atlikums, ko dala čats un API: vispirms šīs dienas plāna kvota, tad iegādātais kredīts. API nav savas kvotas.
• Pieprasījums rezervē savu izvades budžetu (max_tokens, noklusējums 4,096) un pēc tam tiek rēķināts par tokeniem, ko tas patiešām izmantoja, par modeļa cenu.
• Katra atbilde ziņo savu tokenu skaitu laukā usage. Lapa Atslēgas un izmantošana rāda atlikumu un to, cik maksāja katrs pieprasījums.
• Katrs pieprasījums tiek apkalpots vienlīdz. Vienīgais pieprasījumu biežuma ierobežojums ir flood protection: 120 pieprasījumi minūtē uz kontu. Paralēli sūtīti pieprasījumi gaida rindā.

Ierobežojumi un atlikums Modeļi un cenas Atslēgas un izmantošana

Lauki, kas atkarīgi no modeļa

Katrs modelis pieņem to pašu pieprasījumu. Daži lauki darbojas tikai dažiem modeļiem; tabula norāda, kuriem. Galapunktu lapas uzskaita katru lauku.

Chat Completions

Ja nākat no OpenAI SDK

• Iestatiet bāzes URL uz https://api.shannon-ai.com/v1 un atslēgu uz savu Shannon atslēgu. Tad Chat Completions un Responses izsaukumi darbojas ar SDK tādu, kāds tas ir.
• model jābūt Shannon id. Uz cita pakalpojumu sniedzēja modeļa nosaukumu, piemēram, gpt-4o, atbild ar 400 un unknown model.
• Spriešana nāk atsevišķā laukā: reasoning_content blakus content, ziņojumā un straumes delta.
• Straume savā pēdējā daļā vienmēr nes usage kopā ar finish_reason.
• Rīka izsaukums straumē ierodas kā viena daļa ar pilnu arguments virkni.
• Atbildē ir viena izvēle.
• Uz OpenAI API ceļiem, kas nav augstāk esošajā tabulā, piemēram, /v1/embeddings, atbild ar 404.

Ja nākat no Anthropic SDK

• Iestatiet bāzes URL uz https://api.shannon-ai.com, bez /v1, un atslēgu uz savu Shannon atslēgu. SDK to sūta kā x-api-key.
• model jābūt Shannon id.
• max_tokens šajā API nav obligāts. Tā noklusējums ir 4,096.
• Atbilde satur satura blokus ar tipu thinking, text un tool_use. Pirmais bloks ne vienmēr ir teksts: izvēlieties blokus pēc type.
• stop_reason ir end_turn vai tool_use. Shannon modeļa straume var beigties arī ar max_tokens.
• anthropic-version un anthropic-beta tiek pieņemti, tāpēc SDK darbojas bez izmaiņām. Pieprasījumam tie nav vajadzīgi.
• Kļūdām galapunktā /v1/messages ir Anthropic forma: {"type": "error", "error": {…}}.

Kodēšanas rīki, kas runā šajos formātos, tiek iestatīti tāpat: bāzes URL, atslēga un Shannon id kā modelis. CLI kodēšanas rīki