Simira kuzvirimo
Kusimbisa

Kusimbisa

Request imwe neimwe inotakura API key yako mu-header. Key imwe pa-account inoshanda pa-endpoint imwe neimwe nema-model ese, nenzira mbiri dze-header.

Header · OpenAI SDKs
Authorization: Bearer YOUR_API_KEY
Header · Anthropic SDKs
x-api-key: YOUR_API_KEY

Headers dzinogamuchirwa

Ma-header ese maviri anoverengwa pa-/v1 endpoint imwe neimwe, chero format ipi inotaurwa ne-endpoint. Tumira imwe yawo.

Header Tsananguro
Authorization: Bearer <key> Inotariswa pakutanga. Nyora Bearer ne-B huru uye space imwe pamberi pe-key. OpenAI SDKs dzinotumira header iyi.
x-api-key: <key> Inoverengwa kana request isina Authorization: Bearer header. Anthropic SDKs dzinotumira header iyi.

Ne-OpenAI SDK, isa key ne-base URL; SDK inotumira Authorization: Bearer.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1"
)

response = client.chat.completions.create(
    model="shannon-3",
    messages=[
        {"role": "user", "content": "Hello, Shannon!"}
    ]
)

print(response.choices[0].message.content)

Ne-Anthropic SDK, isa key ne-base URL isina /v1; SDK inotumira x-api-key.

import anthropic

client = anthropic.Anthropic(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com"
)

message = client.messages.create(
    model="shannon-3",
    max_tokens=1024,
    messages=[
        {"role": "user", "content": "Hello, Shannon!"}
    ]
)

print("".join(block.text for block in message.content if block.type == "text"))

Ndedzipi endpoints dzinoda key

Endpoint Key
POST /v1/chat/completions Inodiwa
POST /v1/messages Inodiwa
POST /v1/responses Inodiwa
POST /v1/tokenize Inodiwa
POST /v1/messages/count_tokens Inodiwa
GET /v1/models Hadzidiwi

Key yako

  • Key ndi-sk- inoteverwa ne-characters 43 kubva ku-A–Z, a–z, 0–9, - ne-_: characters 46 pamwe chete.
  • Account imwe neimwe ine key imwe chete. Inogadzirwa pawakatanga kuvhura Keys & usage.
  • Key inopa kuwana kwakazara kuAPI ye-account yako: endpoint dzese, ma-model ese ne-balance yose.
  • Key haina zuva rekupera. Inoshanda kusvika wakaichinja kana kuibvisa.

Chinja nekubvisa

Unochinja nekubvisa key papeji reKeys & usage. Keys & usage

Chiito Zvinoitika
Chinja Key itsva inopiwa uye key yekare inomira kushanda. Key itsva inoshanda pakarepo.
Bvisa Key inomira kushanda uye hapana key itsva inopiwa. Chinja kuti uwane key inoshanda zvakare.
  • Zvese zviri zviviri zvinoshanda pakarepo: request inotevera ne-key yekare inopindurwa ne-401. Tora masekonzi 60 sepamusoro pekupedzisira kusati kwarambwa key yekare kwese kwese.
  • Ma-client ese e-account anoshandisa key imwechete, saka kuchinja kunosvika kwavari vese. Isa key itsva mu-ma-client ako pakarepo mushure mekuchinja.
  • Balance, usage ne-flood protection ndzve-account, kwete ye-key. Key itsva inoenderera ne-balance imwechete uye huwandu hwe-request hwakafanana hwaminiti yazvino.

Errors

Kundikana kwese kwe-authentication kune status 401 ne-type authentication_error. Message inosiyanisa nyaya.

Status Mhando Message Rinhi
401 authentication_error Missing authentication Request haina Authorization: Bearer header kana x-api-key header inotanga ne-sk-. Iyi ndiyo zvakare mhinduro ye-bearer yakanyorwa nemavara madiki uye ye-Authorization value isina Bearer.
401 authentication_error Invalid API key Key haisi key yazvino ye-account: yakanyorwa zvisizvo, yakabviswa, kana yakatsiviwa nekuchinja.
{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key",
    "code": "invalid_api_key",
    "param": null
  }
}
  • Pa-path dzese kunze kwe-/v1/messages error object ine zvakare code: "invalid_api_key", kunyange key isipo, ne-param: null.
  • Key inotariswa body isati yaverengwa. Request isina key chaiyo inowana 401 kunyange body yayo isiri chaiyo kana yakakura kwazvo.
  • Authorization: Bearer value isingatanga ne-sk- haitorwi seAPI key. Inowana 401 ine message inoti token haina kunaka kana yapera nguva.

Browsers ne-CORS

  • API inopindura cross-origin browser requests chete kune rondedzero yakatarwa ye-origins. JavaScript iri pa-peji re-origin imwe haigoni kuverenga /v1 replies.
  • Danidzira API kubva pa-server yako uye siya peji rako richitaura ne-server yako. Izvi zvinochengeta key kunze kwe-page source.
  • Server-side code ne-command-line tools hazvikanganiswi: mutemo uyu unoshandiswa ne-browsers chete.
  • Kupinda pa-shannon-ai.com hakusimbisi /v1 requests. Cookies hadziverengwi ipapo; key ndiyo credential imwe chete.
  • Kune origin inobvumirwa, browser inogona kutumira content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta ne-x-request-id, uye inogona kuverenga reply header x-request-id.

Kuchengeta key yakachengeteka

  • Chengeta key pa-server. Usaiise mu-web pages, mobile apps kana public repositories: ani naani anayo anogona kushandisa balance yako yese.
  • Tora key kubva ku-environment variable kana secret store panzvimbo pekuinyora mu-code.
  • Kana key ingave yakaburitswa, ichinje pa-Keys & usage. Key yekare inomira kushanda pakarepo.
  • Mushure mekuburitswa kwe-key, verenga request list pa-Keys & usage. Inoratidza request imwe neimwe yakaitwa ne-key mumazuva 30 apfuura.