Overblik

Endpoints

Hvert endpoint ligger under én base-URL og leveres over HTTPS.

https://api.shannon-ai.com

De tre endpoints, der producerer tekst, når de samme modeller. Vælg det, hvis format din kode allerede bruger.

Grundlæggende om anmodninger

• Body'en i hver POST er ét JSON-objekt på op til 32 MiB.
• Et felt, API'et ikke kender, giver ingen fejl og har ingen virkning. En anmodning skrevet til en anden udbyder fejler ikke på grund af et ekstra felt.
• Et kendt felt med den forkerte JSON-type eller et manglende påkrævet felt besvares med 422. En body, der ikke er gyldig JSON, besvares med 400.
• model er et af id'erne under Modeller og priser. Store og små bogstaver er ligegyldige.

Et svar er JSON eller en stream af server-sent events, når anmodningen sætter stream til true. Hvert endpoint svarer i sit eget format. Hvert svar har headeren x-request-id.

Hvad en anmodning skal igennem

En anmodning kontrolleres i en fast rækkefølge, før en model kører. Den første kontrol, der fejler, svarer, så en 401 fortæller endnu intet om body'en.

Fejlens form

En fejl er et JSON-objekt med en error, der indeholder type og message. /v1/messages pakker den ind, som Anthropic-SDK'er forventer; alle andre stier bruger 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 og message. code og param findes kun på nogle fejl: behandl dem som valgfri. param er altid null.
• Når en stream er startet, er statussen allerede 200. En fejl ankommer da som en fejlramme inde i streamen.
• Hvert fejlsvar indeholder headeren x-request-id.

Fejlhåndtering

Fakturering og balance

• Der er én saldo per konto, og chat og API deler den: først dagens plan-kvote, derefter købt kredit. API'et har ingen egen kvote.
• En anmodning reserverer sit outputbudget (max_tokens, standard 4,096) og afregnes derefter for de tokens, den reelt brugte, til modellens pris.
• Hvert svar rapporterer sine token-tællinger i usage. Siden Nøgler og forbrug viser saldoen og hvad hver anmodning kostede.
• Hver anmodning betjenes lige. Den eneste grænse for anmodningshastighed er flood protection: 120 anmodninger per minut per konto. Anmodninger sendt parallelt venter i kø.

Grænser og saldo Modeller og priser Nøgler og forbrug

Felter, der afhænger af modellen

Alle modeller tager den samme anmodning. Nogle få felter har kun virkning på visse modeller; tabellen nævner hvilke. Endpoint-siderne opregner hvert felt.

Chat Completions

Hvis du kommer fra et OpenAI-SDK

• Sæt base-URL'en til https://api.shannon-ai.com/v1 og nøglen til din Shannon-nøgle. Kald til Chat Completions og Responses virker så med SDK'et, som det er.
• model skal være et Shannon-id. Et modelnavn fra en anden udbyder, f.eks. gpt-4o, besvares med 400 og unknown model.
• Ræsonnement kommer i et felt for sig: reasoning_content ved siden af content, i beskeden og i stream-deltaerne.
• En stream har altid usage i sit sidste chunk sammen med finish_reason.
• Et værktøjskald i en stream ankommer som ét chunk med den komplette arguments-streng.
• Et svar har ét valg.
• Stier i OpenAI API'et, der ikke står i tabellen ovenfor, f.eks. /v1/embeddings, besvares med 404.

Hvis du kommer fra et Anthropic-SDK

• Sæt base-URL'en til https://api.shannon-ai.com, uden /v1, og nøglen til din Shannon-nøgle. SDK'et sender den som x-api-key.
• model skal være et Shannon-id.
• max_tokens er valgfri i dette API. Standardværdien er 4,096.
• Et svar indeholder indholdsblokke af typen thinking, text og tool_use. Den første blok er ikke altid teksten: vælg blokke efter type.
• stop_reason er end_turn eller tool_use. En stream fra en Shannon-model kan også slutte med max_tokens.
• anthropic-version og anthropic-beta accepteres, så SDK'et virker uændret. En anmodning behøver dem ikke.
• Fejl på /v1/messages har Anthropic-formen: {"type": "error", "error": {…}}.

Kodeværktøjer, der taler disse formater, sættes op på samme måde: base-URL, nøgle og et Shannon-id som model. CLI-kodeværktøjer