Yleiskatsaus

Päätepisteet

Jokainen päätepiste sijaitsee yhden perus-URL:n alla ja sitä palvellaan HTTPS:n yli.

https://api.shannon-ai.com

Kolme tekstiä tuottavaa päätepistettä tavoittavat samat mallit. Valitse se, jonka muotoa koodisi jo käyttää.

Pyyntöjen perusteet

• Jokaisen POST-pyynnön runko on yksi JSON-objekti, enintään 32 MiB.
• Kenttä, jota API ei tunne, ei aiheuta virhettä eikä vaikuta mihinkään. Toiselle palveluntarjoajalle kirjoitettu pyyntö ei epäonnistu ylimääräisen kentän vuoksi.
• Tunnettuun kenttään, jonka JSON-tyyppi on väärä, tai puuttuvaan pakolliseen kenttään vastataan 422:lla. Runkoon, joka ei ole kelvollista JSONia, vastataan 400:lla.
• model on jokin Models & pricing -sivun id:istä. Isoilla ja pienillä kirjaimilla ei ole väliä.

Vastaus on JSON tai server-sent events -striimi, kun pyyntö asettaa stream-arvoksi true. Jokainen päätepiste vastaa omassa muodossaan. Jokaisessa vastauksessa on otsake x-request-id.

Mitä pyyntö läpäisee

Pyyntö tarkistetaan kiinteässä järjestyksessä ennen kuin malli suoritetaan. Ensimmäinen epäonnistuva tarkistus vastaa, joten 401 ei vielä kerro mitään rungosta.

Virheen muoto

Virhe on JSON-objekti, jossa on error, joka sisältää kentät type ja message. /v1/messages käärii sen niin kuin Anthropic-SDK:t odottavat; kaikki muut polut käyttävät OpenAI-muotoa.

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

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

• Lue type ja message. code ja param ovat mukana vain joissakin virheissä: pidä niitä valinnaisina. param on aina null.
• Kun striimi on alkanut, tila on jo 200. Virhe saapuu silloin virhekehyksenä striimin sisällä.
• Jokaisessa virhevastauksessa on otsake x-request-id.

Virheiden käsittely

Laskutus ja saldo

• Tiliä kohti on yksi saldo, jota chat ja API jakavat: ensin tämän päivän kiintiö, sitten ostettu saldo. API:lla ei ole omaa kiintiötä.
• Pyyntö varaa tulostebudjettinsa (max_tokens, oletus 4,096) ja sen jälkeen siitä veloitetaan todella käytetyt tokenit mallin hinnalla.
• Jokainen vastaus ilmoittaa tokenmääränsä kentässä usage. Keys & usage -sivu näyttää saldon ja sen, mitä kukin pyyntö maksoi.
• Jokaista pyyntöä palvellaan yhtä lailla. Ainoa pyyntötahdin raja on tulvasuoja: 120 pyyntöä minuutissa tiliä kohti. Rinnakkain lähetetyt pyynnöt odottavat jonossa.

Rajat ja saldo Mallit ja hinnoittelu Avaimet ja käyttö

Mallista riippuvat kentät

Jokainen malli ottaa saman pyynnön. Muutama kenttä vaikuttaa vain joillakin malleilla; taulukko nimeää, millä. Päätepistesivut listaavat jokaisen kentän.

Chat Completions

Tulet OpenAI-SDK:sta

• Aseta perus-URL:ksi https://api.shannon-ai.com/v1 ja avaimeksi Shannon-avaimesi. Chat Completions- ja Responses-kutsut toimivat silloin SDK:n kanssa sellaisenaan.
• model-arvon on oltava Shannon-id. Toisen palveluntarjoajan mallin nimeen, kuten gpt-4o, vastataan 400:lla ja viestillä unknown model.
• Päättely tulee omassa kentässään: reasoning_content kentän content vieressä, viestissä ja striimin deltoissa.
• Striimin viimeisessä chunkissa on aina usage yhdessä finish_reason-kentän kanssa.
• Työkalukutsu striimissä saapuu yhtenä chunkina, jossa on koko arguments-merkkijono.
• Vastauksessa on yksi choice.
• OpenAI API:n polkuihin, joita ei ole yllä olevassa taulukossa, kuten /v1/embeddings, vastataan 404:llä.

Tulet Anthropic-SDK:sta

• Aseta perus-URL:ksi https://api.shannon-ai.com, ilman /v1, ja avaimeksi Shannon-avaimesi. SDK lähettää sen otsakkeena x-api-key.
• model-arvon on oltava Shannon-id.
• max_tokens on tässä API:ssa valinnainen. Sen oletus on 4,096.
• Vastaus sisältää sisältölohkoja tyypeistä thinking, text ja tool_use. Ensimmäinen lohko ei aina ole teksti: valitse lohkot kentän type mukaan.
• stop_reason on end_turn tai tool_use. Shannon-mallin striimi voi päättyä myös arvoon max_tokens.
• anthropic-version ja anthropic-beta hyväksytään, joten SDK toimii muuttumattomana. Pyyntö ei tarvitse niitä.
• Päätepisteen /v1/messages virheillä on Anthropicin muoto: {"type": "error", "error": {…}}.

Koodaustyökalut, jotka puhuvat näitä muotoja, asetetaan samalla tavalla: perus-URL, avain ja Shannon-id mallina. CLI-koodaustyökalut