Iwwersiicht

Endpoints

All Endpoint läit ënner enger Basis-URL a gëtt iwwer HTTPS bedéngt.

https://api.shannon-ai.com

Déi dräi Endpoints, déi Text produzéieren, erreechen déiselwecht Modeller. Wielt deen, dessen Format Äre Code scho benotzt.

Grondlage vun der Ufro

• De Body vun all POST ass een JSON-Objet, bis zu 32 MiB.
• E Feld, dat d'API net kennt, verursaacht kee Feeler a wierkt net. Eng Ufro, déi fir en aneren Ubidder geschriwwe gouf, schléit net wéinst engem zousätzleche Feld fehl.
• E bekannt Feld mam falsche JSON-Typ, oder en erfuerderlecht Feld, dat feelt, gëtt mat 422 beäntwert. E Body, deen net gülteg JSON ass, gëtt mat 400 beäntwert.
• model ass eng vun den IDen op Modeller & Präisser. Grouss- a Klengschreiwung spillt keng Roll.

Eng Äntwert ass JSON, oder e Stream vu Server-sent Events, wann d'Ufro stream op true setzt. All Endpoint äntwert a sengem eegene Format. All Äntwert huet den Header x-request-id.

Wat eng Ufro duerchleeft

Eng Ufro gëtt a fixer Reiefolleg kontrolléiert, ier e Modell leeft. Déi éischt Kontroll, déi feelschléit, äntwert, sou datt e 401 iwwer de Body nach näischt seet.

Form vun de Feeler

E Feeler ass e JSON-Objet mat engem error, deen type a message enthält. /v1/messages packt en esou an, wéi d'Anthropic-SDKs et erwaarden; all aner Pfad benotzt d'OpenAI-Form.

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

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

• Liest type a message. code a param si just bei e puer Feeler do: behandelt se als optional. param ass ëmmer null.
• Nodeems e Stream ugefaang huet, ass de Status schonn 200. E Feeler dono kënnt als Feeler-Frame am Stream.
• All Feeler-Äntwert enthält den Header x-request-id.

Feelerbehandlung

Facturatioun a Solde

• Et gëtt een Solde pro Kont, a Chat an API deelen en: fir d'éischt d'Plan-Zuelung vun haut, dann de gekaafte Crédit. D'API huet keng eege Quota.
• Eng Ufro reservéiert hiren Output-Budget (max_tokens, Standard 4,096) a gëtt dann fir d'Tokens berechent, déi si wierklech benotzt huet, zum Präis vum Modell.
• All Äntwert mellt hir Tokenzuelen an usage. D'Säit Schlësselen & Notzung weist de Solde a wat all Ufro kascht huet.
• All Ufro gëtt gläich behandelt. Déi eenzeg Limit fir d'Ufro-Rate ass de Flood-Schutz: 120 Ufroen pro Minutt pro Kont. Ufroen, déi parallel geschéckt ginn, waarde an der Schlaang.

Limiten a Solde Modeller a Präisser Schlësselen & Notzung

Felder, déi vum Modell ofhänken

All Modell hëlt déiselwecht Ufro. E puer Felder wierken nëmmen bei e puer Modeller; d'Tabell seet wou. D'Säite vun den Endpoints lëschten all Feld op.

Chat Completions

Wann Dir vun engem OpenAI-SDK kënnt

• Setzt d'Basis-URL op https://api.shannon-ai.com/v1 an de Schlëssel op Äre Shannon-Schlëssel. Chat-Completions- a Responses-Ruffer funktionéieren dann mat der SDK esou, wéi se ass.
• model muss eng Shannon-ID sinn. E Modellnumm vun engem anere Ubidder, wéi gpt-4o, gëtt mat 400 an unknown model beäntwert.
• D'Reasoning kënnt an engem eegene Feld: reasoning_content niewent content, an der Message an an de Stream-Deltaen.
• E Stream enthält ëmmer usage a sengem leschte Chunk, zesumme mat finish_reason.
• E Tool-Ruff an engem Stream kënnt als ee Chunk mam kompletten arguments-String.
• Eng Äntwert huet eng Choice.
• Pfaden vun der OpenAI-API, déi net an der Tabell uewen stinn, wéi /v1/embeddings, ginn mat 404 beäntwert.

Wann Dir vun engem Anthropic-SDK kënnt

• Setzt d'Basis-URL op https://api.shannon-ai.com, ouni /v1, an de Schlëssel op Äre Shannon-Schlëssel. D'SDK schéckt en als x-api-key.
• model muss eng Shannon-ID sinn.
• max_tokens ass bei dëser API optional. De Standard ass 4,096.
• Eng Äntwert enthält Inhaltsblöck vum Typ thinking, text an tool_use. Deen éischte Block ass net ëmmer den Text: sicht d'Blöck no type eraus.
• stop_reason ass end_turn oder tool_use. E Stream vun engem Shannon-Modell kann och mat max_tokens ophalen.
• anthropic-version an anthropic-beta ginn akzeptéiert, sou datt d'SDK onverännert funktionéiert. Eng Ufro brauch se net.
• Feeler op /v1/messages hunn d'Anthropic-Form: {"type": "error", "error": {…}}.

Coding-Tools, déi dës Formater schwätzen, ginn op déiselwecht Manéier agestallt: Basis-URL, Schlëssel, an eng Shannon-ID als Modell. CLI-Coding-Tools