Doğrulama

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Qəbul edilən başlıqlar

Hər iki başlıq endpoint hansı formatda danışırsa danışsın, hər /v1 endpoint-də oxunur. Onlardan birini göndərin.

OpenAI SDK ilə açarı və əsas URL-i təyin edin; SDK Authorization: Bearer göndərir.

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 ilə açarı və /v1 olmadan əsas URL-i təyin edin; SDK x-api-key göndərir.

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

Hansı endpoint-lərə açar lazımdır

Açarınız

• Açar sk- və ardınca A–Z, a–z, 0–9, - və _ simvollarından 43 simvoldur: cəmi 46 simvol.
• Hər hesabın dəqiq bir açarı var. O, Keys & usage səhifəsini ilk dəfə açdığınız zaman yaradılır.
• Açar hesabınız üçün API-yə tam giriş verir: hər endpoint, hər model və balansın hamısı.
• Açarın bitmə tarixi yoxdur. Siz onu yeniləyənə və ya ləğv edənə qədər işləyir.

Yeniləmə və ləğv etmə

Açarı Keys & usage səhifəsində yeniləyir və ləğv edirsiniz. Keys & usage

• Hər ikisi dərhal qüvvəyə minir: köhnə açarla növbəti sorğuya 401 cavabı verilir. Köhnə açarın hər yerdə rədd edilməsi üçün yuxarı hədd kimi 60 saniyəni qəbul edin.
• Hesabın bütün klientləri eyni açardan istifadə edir, buna görə yeniləmə hamısına təsir edir. Yenilədikdən dərhal sonra yeni açarı klientlərinizə qoyun.
• Balans, istifadə və flood protection açara yox, hesaba aiddir. Yeni açar eyni balans və cari dəqiqə üçün eyni sorğu sayı ilə davam edir.

Xətalar

Hər doğrulama xətasının statusu 401, tipi isə authentication_error-dur. Halları mesaj bir-birindən ayırır.

{
  "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 istisna olmaqla hər yolda error obyektində həmçinin code: "invalid_api_key" və param: null olur, açar olmadıqda da.
• Açar gövdə oxunmazdan əvvəl yoxlanılır. Etibarlı açarı olmayan sorğu, gövdəsi yanlış və ya çox böyük olsa belə, 401 alır.
• sk- ilə başlamayan Authorization: Bearer dəyəri API açarı sayılmır. O, tokenin yanlış və ya müddətinin bitmiş olduğunu bildirən mesajla 401 alır.

Brauzerlər və CORS

• API cross-origin brauzer sorğularına yalnız sabit mənşə siyahısı üçün cavab verir. Başqa mənşəli səhifədəki JavaScript /v1 cavablarını oxuya bilməz.
• API-ni serverinizdən çağırın və səhifənizin serverinizlə əlaqə qurmasına icazə verin. Bu, həm də açarı səhifə mənbəyindən kənarda saxlayır.
• Server tərəfindəki kod və komanda sətri alətlərinə bu təsir etmir: bu qaydanı yalnız brauzerlər tətbiq edir.
• shannon-ai.com saytında daxil olmaq /v1 sorğularını doğrulamır. Cookie-lər orada oxunmur; açar yeganə etibarnamədir.
• İcazə verilmiş mənşə üçün brauzer content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta və x-request-id göndərə, x-request-id cavab başlığını isə oxuya bilər.

Açarın təhlükəsizliyini qorumaq

• Açarı serverdə saxlayın. Onu veb səhifələrə, mobil tətbiqlərə və ya ictimai repozitoriyalara qoymayın: ona sahib olan hər kəs bütün balansınızı xərcləyə bilər.
• Açarı koda yazmaq əvəzinə mühit dəyişənindən və ya secret store-dan yükləyin.
• Açar sızmış ola bilərsə, onu Keys & usage səhifəsində yeniləyin. Köhnə açar dərhal işləməyi dayandırır.
• Sızmadan sonra Keys & usage səhifəsindəki sorğu siyahısını oxuyun. O, açarın son 30 gündə etdiyi hər sorğunu göstərir.