Oorsig

Eindpunte

Elke eindpunt woon onder een basis-URL en word oor HTTPS bedien.

https://api.shannon-ai.com

Die drie eindpunte wat teks lewer, bereik dieselfde modelle. Kies die een waarvan die formaat jou kode reeds gebruik.

Versoekbeginsels

• Die liggaam van elke POST is een JSON-objek, tot 32 MiB.
• 'n Veld wat die API nie ken nie, veroorsaak geen fout nie en het geen effek nie. 'n Versoek wat vir 'n ander verskaffer geskryf is, misluk nie weens 'n ekstra veld nie.
• 'n Bekende veld met die verkeerde JSON-tipe, of 'n ontbrekende vereiste veld, word met 422 beantwoord. 'n Liggaam wat nie geldige JSON is nie, word met 400 beantwoord.
• model is een van die id's op Modelle en pryse. Hoof- en kleinletters maak nie saak nie.

'n Antwoord is JSON, of 'n stroom van bediener-gestuurde gebeure wanneer die versoek stream op true stel. Elke eindpunt antwoord in sy eie formaat. Elke antwoord het die header x-request-id.

Wat 'n versoek deurloop

'n Versoek word in 'n vaste volgorde nagegaan voordat 'n model loop. Die eerste toets wat misluk, antwoord, so 'n 401 sê jou nog niks oor die liggaam nie.

Foutvorm

'n Fout is 'n JSON-objek met 'n error wat type en message hou. /v1/messages draai dit soos Anthropic-SDK's verwag; elke ander pad gebruik die OpenAI-vorm.

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

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

• Lees type en message. code en param is net by sommige foute teenwoordig: behandel hulle as opsioneel. param is altyd null.
• Nadat 'n stroom begin het, is die status reeds 200. 'n Mislukking kom dan as 'n foutraam binne die stroom aan.
• Elke foutantwoord dra die header x-request-id.

Fouthantering

Fakturering en balans

• Daar is een balans per rekening, en klets en API deel dit: eers vandag se plan-toelaat, dan aangekoopte krediet. Die API het nie 'n kwota van sy eie nie.
• 'n Versoek reserveer sy uitvoerbegroting (max_tokens, verstek 4,096) en word dan gehef vir die tokens wat dit werklik gebruik het, teen die prys van die model.
• Elke antwoord meld sy tokengetalle in usage. Die bladsy Sleutels en gebruik wys die balans en wat elke versoek gekos het.
• Elke versoek word gelyk bedien. Die enigste perk op versoektempo is vloedbeskerming: 120 versoeke per minuut per rekening. Versoeke wat parallel gestuur word, wag in 'n tou.

Perke en balans Modelle en pryse Sleutels en gebruik

Velde wat van die model afhang

Elke model neem dieselfde versoek. 'n Paar velde het net op sommige modelle effek; die tabel noem waar. Die eindpuntbladsye lys elke veld.

Chat Completions

As jy van 'n OpenAI-SDK af kom

• Stel die basis-URL op https://api.shannon-ai.com/v1 en die sleutel op jou Shannon-sleutel. Chat Completions- en Responses-oproepe werk dan met die SDK soos dit is.
• model moet 'n Shannon-id wees. 'n Modelnaam van 'n ander verskaffer, soos gpt-4o, word met 400 en unknown model beantwoord.
• Redenering kom in 'n veld van sy eie: reasoning_content langs content, in die boodskap en in die stroom-deltas.
• 'n Stroom dra altyd usage in sy laaste chunk, saam met finish_reason.
• 'n Gereedskapoproep in 'n stroom kom as een chunk met die volledige arguments-string aan.
• 'n Antwoord het een keuse.
• Paaie van die OpenAI API wat nie in die tabel hierbo is nie, soos /v1/embeddings, word met 404 beantwoord.

As jy van 'n Anthropic-SDK af kom

• Stel die basis-URL op https://api.shannon-ai.com, sonder /v1, en die sleutel op jou Shannon-sleutel. Die SDK stuur dit as x-api-key.
• model moet 'n Shannon-id wees.
• max_tokens is opsioneel op hierdie API. Die verstek is 4,096.
• 'n Antwoord hou inhoudblokke van tipe thinking, text en tool_use. Die eerste blok is nie altyd die teks nie: kies blokke volgens type.
• stop_reason is end_turn of tool_use. 'n Stroom van 'n Shannon-model kan ook met max_tokens eindig.
• anthropic-version en anthropic-beta word aanvaar, so die SDK werk ongewysig. 'n Versoek het hulle nie nodig nie.
• Foute op /v1/messages het die Anthropic-vorm: {"type": "error", "error": {…}}.

Koderingsgereedskap wat hierdie formate praat, word op dieselfde manier opgestel: basis-URL, sleutel, en 'n Shannon-id as die model. CLI-koderingsgereedskap