Översikt

Endpoints

Varje endpoint ligger under en bas-URL och serveras över HTTPS.

https://api.shannon-ai.com

De tre endpoints som producerar text når samma modeller. Välj den vars format din kod redan använder.

Grunderna för begäranden

• Bodyn i varje POST är ett JSON-objekt, upp till 32 MiB.
• Ett fält som API:et inte känner till ger inget fel och har ingen effekt. En begäran skriven för en annan leverantör misslyckas inte på grund av ett extra fält.
• Ett känt fält med fel JSON-typ, eller ett saknat obligatoriskt fält, besvaras med 422. En body som inte är giltig JSON besvaras med 400.
• model är ett av id:na på Modeller och priser. Versaler och gemener spelar ingen roll.

Ett svar är JSON, eller en ström av server-sent events när begäran sätter stream till true. Varje endpoint svarar i sitt eget format. Varje svar har headern x-request-id.

Vad en begäran går igenom

En begäran kontrolleras i en fast ordning innan en modell körs. Den första kontrollen som misslyckas svarar, så en 401 säger ännu inget om bodyn.

Felens form

Ett fel är ett JSON-objekt med ett error som innehåller type och message. /v1/messages omsluter det på det sätt som Anthropic-SDK:er förväntar sig; varje annan sökväg använder OpenAI-formen.

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

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

• Läs type och message. code och param finns bara på vissa fel: behandla dem som valfria. param är alltid null.
• När en ström har startat är statusen redan 200. Ett fel kommer då som en felframe inne i strömmen.
• Varje felsvar innehåller headern x-request-id.

Felhantering

Fakturering och balans

• Det finns en balans per konto, och chatten och API:et delar den: först dagens plankvot, sedan inköpt kredit. API:et har ingen egen kvot.
• En begäran reserverar sin outputbudget (max_tokens, standard 4,096) och debiteras sedan för de tokens den faktiskt använde, till modellens pris.
• Varje svar rapporterar sina tokenräkningar i usage. Sidan Nycklar och användning visar balansen och vad varje begäran kostade.
• Varje begäran betjänas lika. Den enda gränsen för begäranfrekvens är flood protection: 120 begäranden per minut och konto. Begäranden som skickas parallellt väntar i kö.

Gränser och balans Modeller och priser Nycklar och användning

Fält som beror på modellen

Varje modell tar samma begäran. Några fält får effekt bara på vissa modeller; tabellen anger var. Endpointsidorna listar varje fält.

Chat Completions

Om du kommer från en OpenAI-SDK

• Sätt bas-URL:en till https://api.shannon-ai.com/v1 och nyckeln till din Shannon-nyckel. Anrop till Chat Completions och Responses fungerar då med SDK:n som den är.
• model måste vara ett Shannon-id. Ett modellnamn från en annan leverantör, till exempel gpt-4o, besvaras med 400 och unknown model.
• Resonemanget kommer i ett eget fält: reasoning_content bredvid content, i meddelandet och i strömmens deltan.
• En ström bär alltid usage i sin sista chunk, tillsammans med finish_reason.
• Ett verktygsanrop i en ström kommer som en enda chunk med hela arguments-strängen.
• Ett svar har ett choice.
• Sökvägar i OpenAI-API:et som inte finns i tabellen ovan, till exempel /v1/embeddings, besvaras med 404.

Om du kommer från en Anthropic-SDK

• Sätt bas-URL:en till https://api.shannon-ai.com, utan /v1, och nyckeln till din Shannon-nyckel. SDK:n skickar den som x-api-key.
• model måste vara ett Shannon-id.
• max_tokens är valfritt i det här API:et. Standardvärdet är 4,096.
• Ett svar innehåller innehållsblock av typen thinking, text och tool_use. Det första blocket är inte alltid texten: välj block efter type.
• stop_reason är end_turn eller tool_use. En ström från en Shannon-modell kan också sluta med max_tokens.
• anthropic-version och anthropic-beta accepteras, så SDK:n fungerar oförändrad. En begäran behöver dem inte.
• Fel på /v1/messages har Anthropic-formen: {"type": "error", "error": {…}}.

Kodningsverktyg som talar dessa format ställs in på samma sätt: bas-URL, nyckel och ett Shannon-id som modell. CLI-verktyg för kodning