Autentikacija

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Prihvaćena zaglavlja

Oba zaglavlja se čitaju na svakom /v1 endpointu, bez obzira na format koji endpoint govori. Pošaljite jedno od njih.

S OpenAI SDK-om postavite ključ i osnovni URL; SDK šalje 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)

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!"}
    ]
  }'

S Anthropic SDK-om postavite ključ i osnovni URL bez /v1; SDK šalje 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"))

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!"}
    ]
  }'

Koji endpointi trebaju ključ

Vaš ključ

• Ključ je sk- iza kojeg slijedi 43 znaka iz A–Z, a–z, 0–9, - i _: ukupno 46 znakova.
• Svaki račun ima tačno jedan ključ. Kreira se kada prvi put otvorite Ključevi i korištenje.
• Ključ daje puni pristup API-ju za vaš račun: svaki endpoint, svaki model i cijelo stanje.
• Ključ nema datum isteka. Radi dok ga ne rotirate ili opozovete.

Rotacija i opoziv

Ključ rotirate i opozivate na stranici Ključevi i korištenje. Ključevi i korištenje

• Oba djeluju odmah: sljedeći zahtjev sa starim ključem dobija odgovor 401. Računajte 60 sekundi kao gornju granicu prije nego što se stari ključ svuda odbije.
• Svi klijenti računa koriste isti ključ, pa rotacija utiče na sve njih. Stavite novi ključ u svoje klijente odmah nakon rotacije.
• Stanje, korištenje i flood zaštita pripadaju računu, a ne ključu. Novi ključ nastavlja s istim stanjem i istim brojem zahtjeva za tekuću minutu.

Greške

Svaka greška autentifikacije ima status 401 i tip authentication_error. Poruka razlikuje slučajeve.

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

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

• Na svakoj putanji osim /v1/messages objekat error sadrži i code: "invalid_api_key", također za ključ koji nedostaje, i param: null.
• Ključ se provjerava prije čitanja tijela. Zahtjev bez važećeg ključa dobija 401 čak i kada je njegovo tijelo nevažeće ili preveliko.
• Vrijednost Authorization: Bearer koja ne počinje s sk- ne tretira se kao API ključ. Dobija 401 s porukom da je token nevažeći ili istekao.

Preglednici i CORS

• API odgovara na cross-origin zahtjeve preglednika samo za fiksnu listu porijekla (origin). JavaScript na stranici drugog porijekla ne može čitati /v1 odgovore.
• Pozivajte API sa svog servera i neka vaša stranica komunicira s vašim serverom. Time ključ ostaje i izvan izvornog koda stranice.
• Kod na strani servera i alati komandne linije nisu pogođeni: ovo pravilo primjenjuju samo preglednici.
• Prijava na shannon-ai.com ne autentifikuje /v1 zahtjeve. Kolačići se tamo ne čitaju; ključ je jedini kredencijal.
• Za dozvoljeno porijeklo (origin), preglednik može poslati content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta i x-request-id, i može čitati zaglavlje odgovora x-request-id.

Čuvanje ključa

• Držite ključ na serveru. Ne stavljajte ga u web stranice, mobilne aplikacije ili javne repozitorije: ko ga posjeduje može potrošiti cijelo vaše stanje.
• Učitajte ključ iz varijable okruženja ili spremišta tajni umjesto da ga upisujete u kod.
• Ako je ključ možda procurio, rotirajte ga na stranici Ključevi i korištenje. Stari ključ odmah prestaje raditi.
• Nakon curenja pročitajte listu zahtjeva na stranici Ključevi i korištenje. Prikazuje svaki zahtjev koji je ključ napravio u posljednjih 30 dana.