Hitelesítés

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Elfogadott fejlécek

Mindkét fejlécet olvassa minden /v1 végpont, bármelyik formátumot beszéli is. Az egyiket küldd.

OpenAI SDK-val add meg a kulcsot és az alap URL-t; az SDK az Authorization: Bearer fejlécet küldi.

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)

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://api.shannon-ai.com/v1'
});

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

console.log(response.choices[0].message.content);

curl -X POST "https://api.shannon-ai.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "messages": [
      {"role": "user", "content": "Hello, Shannon!"}
    ]
  }'

Anthropic SDK-val add meg a kulcsot és az alap URL-t /v1 nélkül; az SDK az x-api-key fejlécet küldi.

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"))

import Anthropic from '@anthropic-ai/sdk';

const client = new Anthropic({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://api.shannon-ai.com'
});

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

console.log(message.content.filter((block) => block.type === 'text').map((block) => block.text).join(''));

curl -X POST "https://api.shannon-ai.com/v1/messages" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "Hello, Shannon!"}
    ]
  }'

Mely végpontokhoz kell kulcs

A kulcsod

• A kulcs az sk- előtag, majd 43 karakter az A–Z, a–z, 0–9, - és _ készletből: összesen 46 karakter.
• Minden fiókhoz pontosan egy kulcs tartozik. Akkor jön létre, amikor először megnyitod a Keys & usage oldalt.
• A kulcs teljes hozzáférést ad a fiókod API-jához: minden végponthoz, minden modellhez és a teljes egyenleghez.
• A kulcsnak nincs lejárati ideje. Addig működik, amíg le nem cseréled vagy vissza nem vonod.

Csere és visszavonás

A kulcsot a Keys & usage oldalon cseréled le és vonod vissza. Keys & usage

• Mindkettő azonnal életbe lép: a régi kulccsal küldött következő kérésre 401 a válasz. Számolj 60 másodperc felső korláttal, mire a régi kulcsot mindenütt elutasítják.
• A fiók minden kliense ugyanazt a kulcsot használja, ezért a csere mindegyiket érinti. A csere után azonnal told be az új kulcsot a klienseidbe.
• Az egyenleg, a használat és a flood protection a fiókhoz tartozik, nem a kulcshoz. Az új kulcs ugyanazzal az egyenleggel és az aktuális perc ugyanazon kérésszámával folytatja.

Hibák

Minden hitelesítési hiba státusza 401, típusa authentication_error. Az üzenet különbözteti meg az eseteket.

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key",
    "code": "invalid_api_key",
    "param": null
  }
}

{
  "type": "error",
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key"
  }
}

• A /v1/messages kivételével minden útvonalon az error objektum tartalmazza még a code: "invalid_api_key" mezőt is, hiányzó kulcs esetén is, valamint a param: null mezőt.
• A kulcsot a rendszer a törzs beolvasása előtt ellenőrzi. Érvényes kulcs nélküli kérés akkor is 401-et kap, ha a törzse érvénytelen vagy túl nagy.
• Az sk- előtaggal nem kezdődő Authorization: Bearer értéket a rendszer nem kezeli API-kulcsként. 401-et kap, azzal az üzenettel, hogy a token érvénytelen vagy lejárt.

Böngészők és CORS

• Az API csak rögzített originlistára válaszol a cross-origin böngészőkérésekre. Egy másik origin oldalán futó JavaScript nem olvashatja a /v1 válaszokat.
• Az API-t a szerveredről hívd, és az oldalad a szerveroddal beszéljen. Így a kulcs a forráskódban sem jelenik meg.
• A szerveroldali kódot és a parancssori eszközöket ez nem érinti: ezt a szabályt csak a böngészők alkalmazzák.
• A shannon-ai.com-on történt bejelentkezés nem hitelesíti a /v1 kéréseket. A cookie-kat ott nem olvassa a rendszer; a kulcs az egyetlen hitelesítő adat.
• Engedélyezett origin esetén a böngésző küldhet content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta és x-request-id fejlécet, és olvashatja az x-request-id válaszfejlécet.

A kulcs biztonságban tartása

• Tartsd a kulcsot szerveren. Ne tedd weboldalra, mobilalkalmazásba vagy nyilvános repositoryba: aki birtokolja, elkölthet a teljes egyenlegedből.
• A kulcsot környezeti változóból vagy titokkezelőből töltsd be, ne írd a kódba.
• Ha a kulcs kiszivároghatott, cseréld le a Keys & usage oldalon. A régi kulcs azonnal megszűnik működni.
• Kiszivárgás után nézd meg a kérések listáját a Keys & usage oldalon. Megmutatja a kulcs minden kérését az elmúlt 30 napból.