Ümumi baxış

Endpoint-lər

Hər endpoint bir əsas URL altındadır və HTTPS ilə xidmət göstərir.

https://api.shannon-ai.com

Mətn yaradan üç endpoint eyni modellərə çıxış verir. Kodunuzun artıq istifadə etdiyi formatı seçin.

Sorğunun əsasları

• Hər POST-un gövdəsi 32 MiB-a qədər bir JSON obyektidir.
• API-nin tanımadığı sahə xəta yaratmır və təsiri yoxdur. Başqa provayder üçün yazılmış sorğu əlavə sahəyə görə uğursuz olmur.
• Yanlış JSON tipli məlum sahə və ya çatışmayan məcburi sahə 422 ilə cavablandırılır. Etibarlı JSON olmayan gövdə 400 ilə cavablandırılır.
• model Models & pricing səhifəsindəki id-lərdən biridir. Böyük və kiçik hərf fərq etmir.

Cavab JSON-dur, sorğu stream-i true təyin etdikdə isə server-sent events axınıdır. Hər endpoint öz formatında cavab verir. Hər cavabda x-request-id başlığı var.

Sorğunun keçdiyi yoxlamalar

Sorğu model işə düşməzdən əvvəl müəyyən ardıcıllıqla yoxlanılır. Uğursuz olan ilk yoxlama cavab verir, ona görə 401 gövdə haqqında hələ heç nə demir.

Xəta forması

Xəta type və message saxlayan error olan JSON obyektidir. /v1/messages onu Anthropic SDK-larının gözlədiyi kimi bükür; hər digər yol OpenAI formasından istifadə edir.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• type və message-i oxuyun. code və param yalnız bəzi xətalarda olur: onları ixtiyari sayın. param həmişə null-dır.
• Axın başladıqdan sonra status artıq 200-dür. Bu halda uğursuzluq axının içində xəta frame-i kimi gəlir.
• Hər xəta cavabı x-request-id başlığını daşıyır.

Xəta idarəetməsi

Ödəniş və balans

• Hər hesab üçün bir balans var və çat ilə API onu bölüşür: əvvəlcə bugünkü plan limiti, sonra alınmış kredit. API-nin öz kvotası yoxdur.
• Sorğu output büdcəsini (max_tokens, standart 4,096) rezerv edir və sonra real istifadə etdiyi tokenlər üçün modelin qiymətilə hesablanır.
• Hər cavab token saylarını usage-də bildirir. Keys & usage səhifəsi balansı və hər sorğunun nəyə başa gəldiyini göstərir.
• Hər sorğuya bərabər xidmət göstərilir. Sorğu sürətinə yeganə limit flood protection-dır: hesab başına dəqiqədə 120 sorğu. Paralel göndərilən sorğular növbədə gözləyir.

Limitlər və balans Modellər və qiymətlər Keys & usage

Modeldən asılı olan sahələr

Hər model eyni sorğunu qəbul edir. Bəzi sahələr yalnız bəzi modellərdə təsir göstərir; cədvəl harada olduğunu göstərir. Endpoint səhifələri hər sahəni sadalayır.

Chat Completions

OpenAI SDK-dan gələnlər üçün

• Əsas URL-i https://api.shannon-ai.com/v1 kimi, açarı isə Shannon açarınız kimi təyin edin. Onda Chat Completions və Responses çağırışları SDK ilə olduğu kimi işləyir.
• model Shannon id-si olmalıdır. gpt-4o kimi başqa provayderin model adı 400 və unknown model ilə cavablandırılır.
• Reasoning ayrıca sahədə gəlir: mesajda və axın delta-larında content-in yanında reasoning_content.
• Axın usage-i həmişə son chunk-da, finish_reason ilə birlikdə daşıyır.
• Axında alət çağırışı tam arguments sətri olan bir chunk kimi gəlir.
• Cavabda bir choice olur.
• OpenAI API-nin yuxarıdakı cədvəldə olmayan yolları, məsələn /v1/embeddings, 404 ilə cavablandırılır.

Anthropic SDK-dan gələnlər üçün

• Əsas URL-i https://api.shannon-ai.com kimi, /v1 olmadan, açarı isə Shannon açarınız kimi təyin edin. SDK onu x-api-key kimi göndərir.
• model Shannon id-si olmalıdır.
• Bu API-də max_tokens ixtiyaridir. Standart dəyəri 4,096-dır.
• Cavab thinking, text və tool_use tipli məzmun blokları saxlayır. İlk blok həmişə mətn deyil: blokları type-a görə seçin.
• stop_reason end_turn və ya tool_use-dur. Shannon modelinin axını max_tokens ilə də bitə bilər.
• anthropic-version və anthropic-beta qəbul edilir, ona görə SDK dəyişmədən işləyir. Sorğuya onlar lazım deyil.
• /v1/messages-də xətalar Anthropic formasındadır: {"type": "error", "error": {…}}.

Bu formatlarla işləyən kodlaşdırma alətləri eyni qaydada qurulur: əsas URL, açar və model kimi Shannon id-si. CLI kodlaşdırma alətləri