Rastandin

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Header ە قبوڵکراوەکان

هەردوو header لەسەر هەموو endpoint ێکی /v1 دەخوێندرێنەوە، بەبێ گوێدانە ئەو فۆرماتەی endpoint ەکە قسەی پێ دەکات. یەکێکیان بنێرە.

لەگەڵ SDK ی OpenAI، کلیل و 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!"}
    ]
  }'

لەگەڵ SDK ی Anthropic، کلیل و base URL بێ /v1 دیاری بکە؛ 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- ە و دوای ئەوە 43 پیت لە A–Z و a–z و 0–9 و - و _: لە کۆیدا 46 پیت.
• هەر هەژمارێک تەواو یەک کلیلی هەیە. یەکەم جار کە Keys & usage دەکەیتەوە دروست دەکرێت.
• کلیلەکە دەستپێگەیشتنی تەواو بە API ـەکە بۆ هەژمارەکەت دەدات: هەموو endpoint ێک، هەموو مۆدێلێک و هەموو باڵانسەکە.
• کلیل بەرواری بەسەرچوونی نییە. تا ئەو کاتەی دەیگۆڕیت یان هەڵیدەوەشێنیتەوە کار دەکات.

گۆڕین و هەڵوەشاندنەوە

کلیلەکە لە لاپەڕەی Keys & usage دەگۆڕیت و هەڵیدەوەشێنیتەوە. Keys & usage

• هەردووکیان یەکسەر کاریگەر دەبن: داواکاری دواتر بە کلیلی کۆن بە 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.
• کلیلەکە پێش خوێندنەوەی body پشکنین دەکرێت. داواکارییەک بێ کلیلێکی دروست 401 وەردەگرێت تەنانەت ئەگەر body ەکەی نادروست یان زۆر گەورە بێت.
• بەهای Authorization: Bearer ی کە بە sk- دەست پێناکات وەک کلیلی API حیساب ناکرێت. 401 وەردەگرێت لەگەڵ نامەیەک کە دەڵێت تۆکنەکە نادروستە یان بەسەرچووە.

وێبگەڕەکان و CORS

• API تەنها بۆ لیستێکی جێگیری origin ەکان وەڵامی داواکاری cross-origin ی وێبگەڕ دەداتەوە. JavaScript لەسەر لاپەڕەی origin ێکی تر ناتوانێت وەڵامەکانی /v1 بخوێنێتەوە.
• API لە سێرڤەرەکەتەوە بانگ بکە و ڕێ بدە لاپەڕەکەت لەگەڵ سێرڤەرەکەت قسە بکات. ئەمە کلیلەکەش لە سەرچاوەی لاپەڕەکە دووردەخاتەوە.
• کۆدی لایەنی سێرڤەر و ئامرازەکانی هێڵی فەرمان کاریان تێناکرێت: ئەم یاسایە تەنها لەلایەن وێبگەڕەکانەوە جێبەجێ دەکرێت.
• چوونەژوورەوە لە shannon-ai.com داواکارییەکانی /v1 ڕاستنامە ناکات. کووکییەکان لەوێ ناخوێندرێنەوە؛ کلیل تاکە بەڵگەی ناسینەوەیە.
• بۆ origin ێکی ڕێپێدراو، وێبگەڕ دەتوانێت content-type و authorization و x-api-key و anthropic-version و anthropic-beta و openai-beta و x-request-id بنێرێت، و header ی وەڵامی x-request-id بخوێنێتەوە.

پاراستنی کلیلەکە

• کلیلەکە لەسەر سێرڤەر بهێڵەرەوە. مەیخەرە ناو لاپەڕەی وێب یان ئەپی مۆبایل یان ڕیپۆزیتۆری گشتییەوە: هەرکەسێک هەیبێت دەتوانێت هەموو باڵانسەکەت خەرج بکات.
• کلیلەکە لە گۆڕاوی ژینگە یان مەخزەنی نهێنییەکانەوە بار بکە، نەک بینووسە ناو کۆدەوە.
• ئەگەر کلیلەکە لەوانەیە دەرچووبێت، لە Keys & usage بیگۆڕە. کلیلە کۆنەکە یەکسەر کار ناکات.
• دوای دەرچوون، لیستی داواکارییەکان لە Keys & usage بخوێنەرەوە. هەموو ئەو داواکاریانە پیشان دەدات کە کلیلەکە لە 30 ڕۆژی ڕابردوودا ئەنجامی داون.