Oversikt

Endepunkter

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

https://api.shannon-ai.com

De tre endepunktene som produserer tekst, når de samme modellene. Velg det som har formatet koden din allerede bruker.

Grunnleggende om forespørsler

• Kroppen i hver POST er ett JSON-objekt, opptil 32 MiB.
• Et felt API-et ikke kjenner, gir ingen feil og har ingen effekt. En forespørsel skrevet for en annen leverandør feiler ikke på grunn av et ekstra felt.
• Et kjent felt med feil JSON-type, eller et manglende påkrevd felt, besvares med 422. En kropp som ikke er gyldig JSON, besvares med 400.
• model er en av id-ene på Models & pricing. Store og små bokstaver spiller ingen rolle.

Et svar er JSON, eller en strøm av server-sent events når forespørselen setter stream til true. Hvert endepunkt svarer i sitt eget format. Hvert svar har headeren x-request-id.

Hva en forespørsel må igjennom

En forespørsel sjekkes i fast rekkefølge før en modell kjører. Den første sjekken som feiler, svarer, så en 401 sier ennå ingenting om kroppen.

Feilform

En feil er et JSON-objekt med en error som inneholder type og message. /v1/messages pakker den inn slik Anthropic-SDK-er forventer; alle andre stier bruker OpenAI-formen.

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

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

• Les type og message. code og param finnes bare på enkelte feil: behandle dem som valgfrie. param er alltid null.
• Etter at en strøm har startet, er statusen allerede 200. En feil kommer da som en feilramme inne i strømmen.
• Hvert feilsvar har headeren x-request-id.

Feilhåndtering

Fakturering og saldo

• Det finnes én saldo per konto, og chat og API deler den: først dagens plan-kvote, deretter kjøpt kreditt. API-et har ingen egen kvote.
• En forespørsel reserverer utdatabudsjettet sitt (max_tokens, standard 4,096) og belastes deretter for tokens-ene den faktisk brukte, til modellens pris.
• Hvert svar rapporterer tokenantallene sine i usage. Siden Keys & usage viser saldoen og hva hver forespørsel kostet.
• Hver forespørsel behandles likt. Den eneste grensen for forespørselsrate er flood protection: 120 forespørsler per minutt per konto. Forespørsler som sendes parallelt, venter i kø.

Grenser og saldo Modeller og priser Nøkler og bruk

Felt som avhenger av modellen

Alle modeller tar imot den samme forespørselen. Noen få felt har bare effekt på enkelte modeller; tabellen oppgir hvilke. Endepunktsidene lister hvert felt.

Chat Completions

Hvis du kommer fra en OpenAI-SDK

• Sett base-URL-en til https://api.shannon-ai.com/v1 og nøkkelen til Shannon-nøkkelen din. Kall til Chat Completions og Responses fungerer da med SDK-en som den er.
• model må være en Shannon-id. Et modellnavn fra en annen leverandør, som gpt-4o, besvares med 400 og unknown model.
• Resonnering kommer i et eget felt: reasoning_content ved siden av content, i meldingen og i strømdeltaene.
• En strøm har alltid usage i den siste chunken, sammen med finish_reason.
• Et verktøykall i en strøm kommer som én chunk med hele arguments-strengen.
• Et svar har ett valg.
• Stier i OpenAI-API-et som ikke står i tabellen over, som /v1/embeddings, besvares med 404.

Hvis du kommer fra en Anthropic-SDK

• Sett base-URL-en til https://api.shannon-ai.com, uten /v1, og nøkkelen til Shannon-nøkkelen din. SDK-en sender den som x-api-key.
• model må være en Shannon-id.
• max_tokens er valgfri i dette API-et. Standardverdien er 4,096.
• Et svar inneholder innholdsblokker av typene thinking, text og tool_use. Den første blokken er ikke alltid teksten: velg blokker etter type.
• stop_reason er end_turn eller tool_use. En strøm fra en Shannon-modell kan også ende med max_tokens.
• anthropic-version og anthropic-beta godtas, så SDK-en fungerer uendret. En forespørsel trenger dem ikke.
• Feil på /v1/messages har Anthropic-formen: {"type": "error", "error": {…}}.

Kodeverktøy som snakker disse formatene, settes opp på samme måte: base-URL, nøkkel og en Shannon-id som modell. CLI-verktøy for koding