Auðkenning

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Samþykktir hausar

Báðir hausarnir eru lesnir á hverjum /v1 endapunkti, óháð því hvaða snið endapunkturinn talar. Sendu annan hvorn.

Með OpenAI SDK stillirðu lykilinn og base URL; SDK sendir 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!"}
    ]
  }'

Með Anthropic SDK stillirðu lykilinn og base URL án /v1; SDK sendir 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!"}
    ]
  }'

Hvaða endapunktar þurfa lykil

Lykillinn þinn

• Lykill er sk- og síðan 43 stafir úr A–Z, a–z, 0–9, - og _: 46 stafir alls.
• Hver reikningur hefur nákvæmlega einn lykil. Hann er búinn til í fyrsta sinn sem þú opnar Lyklar og notkun.
• Lykillinn veitir fullan aðgang að API fyrir reikninginn þinn: alla endapunkta, öll líkön og alla stöðuna.
• Lykill hefur engan fyrningardag. Hann virkar þar til þú endurnýjar hann eða afturkallar.

Endurnýja og afturkalla

Þú endurnýjar og afturkallar lykilinn á síðunni Lyklar og notkun. Lyklar og notkun

• Hvort tveggja tekur gildi strax: næstu beiðni með gamla lyklinum er svarað með 401. Miðaðu við 60 sekúndur sem efri mörk áður en gamla lyklinum er hafnað alls staðar.
• Allir biðlarar reikningsins nota sama lykil, svo endurnýjun nær til þeirra allra. Settu nýja lykilinn inn í biðlarana strax eftir að þú endurnýjar.
• Staða, notkun og flóðvörn tilheyra reikningnum, ekki lyklinum. Nýr lykill heldur áfram með sömu stöðu og sama beiðnafjölda fyrir yfirstandandi mínútu.

Villur

Hver auðkenningarbilun hefur stöðuna 401 og gerðina authentication_error. Skilaboðin greina tilvikin að.

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

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

• Á öllum slóðum nema /v1/messages geymir error hluturinn einnig code: "invalid_api_key", líka þegar lykil vantar, og param: null.
• Lykillinn er athugaður áður en meginmálið er lesið. Beiðni án gilds lykils fær 401 jafnvel þótt meginmál hennar sé ógilt eða of stórt.
• Authorization: Bearer gildi sem byrjar ekki á sk- er ekki meðhöndlað sem API-lykill. Það fær 401 með skilaboðum um að táknið sé ógilt eða útrunnið.

Vafrar og CORS

• API svarar vafrabeiðnum milli uppruna aðeins fyrir fastan lista af uppruna. JavaScript á síðu af öðrum uppruna getur ekki lesið /v1 svör.
• Kallaðu á API frá þjóninum þínum og láttu síðuna þína tala við þjóninn þinn. Þannig helst lykillinn líka utan við frumkóða síðunnar.
• Þjónskóði og skipanalínutól verða ekki fyrir áhrifum: þessi regla er aðeins framfylgt af vöfrum.
• Innskráning á shannon-ai.com auðkennir ekki /v1 beiðnir. Vafrakökur eru ekki lesnar þar; lykillinn er eina auðkennið.
• Fyrir leyfðan uppruna má vafri senda content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta og x-request-id, og má lesa svarhausinn x-request-id.

Haltu lyklinum öruggum

• Geymdu lykilinn á þjóni. Settu hann ekki í vefsíður, farsímaforrit eða opinber hugbúnaðarsöfn: hver sem hefur hann getur eytt allri stöðunni þinni.
• Hlaða lykilinn úr umhverfisbreytu eða leyndarmálageymslu í stað þess að skrifa hann í kóðann.
• Ef lykillinn kann að hafa lekið skaltu endurnýja hann á Lyklar og notkun. Gamli lykillinn hættir að virka strax.
• Eftir leka skaltu lesa beiðnalistann á Lyklar og notkun. Hann sýnir allar beiðnir sem lykillinn sendi síðustu 30 daga.