Аутентификация

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Кабыл алынган баштар

Эки баш тең ар бир /v1 endpoint'те окулат, endpoint кайсы форматта сүйлөбөсүн. Бирин жөнөтүңүз.

OpenAI SDK менен ачкычты жана base URL'ди коюңуз; SDK 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!"}
    ]
  }'

Anthropic SDK менен ачкычты жана /v1'сиз base URL'ди коюңуз; SDK 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!"}
    ]
  }'

Кайсы endpoint'терге ачкыч керек

Ачкычыңыз

• Ачкыч — sk- жана андан кийин A–Z, a–z, 0–9, - жана _ белгилеринен турган 43 белги: жалпысынан 46 белги.
• Ар бир аккаунттун так бир ачкычы бар. Ал «Ачкычтар жана колдонуу» бетин биринчи ирет ачканда түзүлөт.
• Ачкыч аккаунтуңуз үчүн API'ге толук жетүү берет: ар бир endpoint, ар бир модель жана бүт баланс.
• Ачкычтын мөөнөтү жок. Аны алмаштырганга же жокко чыгарганга чейин иштейт.

Алмаштыруу жана жокко чыгаруу

Ачкычты «Ачкычтар жана колдонуу» бетинде алмаштырасыз жана жокко чыгарасыз. Ачкычтар жана колдонуу

• Экөө тең дароо күчүнө кирет: эски ачкыч менен кийинки сурамга 401 жооп берилет. Эски ачкыч бардык жерде четке кагылганга чейинки жогорку чек катары 60 секундду эсептеңиз.
• Аккаунттун бардык клиенттери бир эле ачкычты колдонот, андыктан алмаштыруу баарына тиет. Алмаштыргандан кийин жаңы ачкычты клиенттериңизге дароо коюңуз.
• Баланс, колдонуу жана flood protection ачкычка эмес, аккаунтка таандык. Жаңы ачкыч ошол эле баланс жана учурдагы мүнөттүн ошол эле сурам саны менен уланат.

Каталар

Аутентификациянын ар бир катасынын статусу 401 жана түрү authentication_error. Учурларды билдирүү айырмалайт.

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

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

• /v1/messages өзгөчөлөнгөн бардык жолдордо error объектисинде дагы code: "invalid_api_key" бар, ачкыч жок болгондо да, жана param: null.
• Ачкыч дене окулганга чейин текшерилет. Жарактуу ачкычсыз сурам, денеси жараксыз же өтө чоң болсо да, 401 алат.
• sk- менен башталбаган Authorization: Bearer мааниси API ачкыч катары кабыл алынбайт. Ал токен жараксыз же мөөнөтү бүткөн деген билдирүү менен 401 алат.

Браузерлер жана CORS

• API браузердин cross-origin сурамдарына origin'дердин бекитилген тизмеси үчүн гана жооп берет. Башка origin'деги беттин JavaScript'и /v1 жоопторун окуй албайт.
• API'ни сервериңизден чалыңыз, ал эми бетиңиз сервериңиз менен сүйлөшсүн. Бул ачкычты беттин булак кодунан да алыс кармайт.
• Сервер тараптагы код жана командалык сап куралдары таасирленбейт: бул эрежени браузерлер гана колдонот.
• shannon-ai.com сайтына кирүү /v1 сурамдарын аутентификациялабайт. Cookie'лер ал жерде окулбайт; ачкыч — жалгыз каражат.
• Уруксат берилген origin үчүн браузер content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta жана x-request-id баштарын жөнөтө алат жана x-request-id жооп башын окуй алат.

Ачкычты коопсуз сактоо

• Ачкычты серверде сактаңыз. Аны веб-беттерге, мобилдик колдонмолорго же ачык репозиторийлерге салбаңыз: ким колунда кармаса, бүт балансыңызды сарптай алат.
• Ачкычты кодго жазбай, чөйрө өзгөрмөсүнөн же сырлар сактагычынан жүктөңүз.
• Ачкыч чыгып кетиши мүмкүн болсо, аны «Ачкычтар жана колдонуу» бетинде алмаштырыңыз. Эски ачкыч дароо иштебей калат.
• Ачкыч жоголгондон кийин «Ачкычтар жана колдонуу» бетиндеги сурамдар тизмесин окуңуз. Ал ачкыч акыркы 30 күндө жасаган ар бир сурамды көрсөтөт.