Umumiy ko‘rinish

Endpointlar

Har bir endpoint bitta base URL ostida va HTTPS orqali xizmat ko'rsatadi.

https://api.shannon-ai.com

Matn hosil qiladigan uchta endpoint bir xil modellarga yetadi. Kodingiz allaqachon ishlatadigan formatdagisini tanlang.

So'rov asoslari

• Har bir POST tanasi bitta JSON obyekti, 32 MiB gacha.
• API bilmaydigan maydon xatoga olib kelmaydi va ta'siri yo'q. Boshqa provayder uchun yozilgan so'rov ortiqcha maydon tufayli muvaffaqiyatsiz bo'lmaydi.
• Noto'g'ri JSON turidagi ma'lum maydon yoki yo'q majburiy maydonga 422 bilan javob beriladi. Yaroqli JSON bo'lmagan tanaga 400 bilan javob beriladi.
• model — Modellar va narxlar sahifasidagi id'lardan biri. Katta va kichik harflar ahamiyatsiz.

Javob JSON yoki so'rov streamni true qilganda server-sent events oqimi. Har bir endpoint o'z formatida javob beradi. Har bir javobda x-request-id sarlavhasi bor.

So'rov nimalardan o'tadi

So'rov model ishga tushishidan oldin qat'iy tartibda tekshiriladi. Muvaffaqiyatsiz bo'lgan birinchi tekshiruv javob beradi, shuning uchun 401 tana haqida hali hech narsa aytmaydi.

Xato shakli

Xato — type va messageni o'z ichiga olgan errorli JSON obyekti. /v1/messages uni Anthropic SDK'lar kutganidek o'raydi; boshqa har bir yo'l OpenAI shaklidan foydalanadi.

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

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

• type va messageni o'qing. code va param faqat ba'zi xatolarda bor: ularni ixtiyoriy deb hisoblang. param doim null.
• Oqim boshlangandan keyin holat allaqachon 200. Nosozlik keyin oqim ichida xato freymi sifatida keladi.
• Har bir xato javobi x-request-id sarlavhasini olib keladi.

Xatolarni boshqarish

To'lov va balans

• Har bir hisobga bitta balans to'g'ri keladi, chat va API uni baham ko'radi: avval bugungi reja limiti, keyin sotib olingan kredit. API'ning o'z kvotasi yo'q.
• So'rov chiqish byudjetini (max_tokens, standart 4,096) ajratib qo'yadi va keyin haqiqatda ishlatgan tokenlari uchun modelning narxida hisoblanadi.
• Har bir javob token sonlarini usageda ko'rsatadi. Keys & usage sahifasi balansni va har bir so'rov qancha turganini ko'rsatadi.
• Har bir so'rovga teng xizmat ko'rsatiladi. So'rovlar tezligi bo'yicha yagona limit — flood himoyasi: hisob uchun daqiqasiga 120 ta so'rov. Parallel yuborilgan so'rovlar navbatda kutadi.

Limitlar va balans Modellar va narxlar Keys & usage

Modelga bog'liq maydonlar

Har bir model bir xil so'rovni qabul qiladi. Bir nechta maydon faqat ba'zi modellarda kuchga kiradi; jadval qayerda ekanini nomlaydi. Endpoint sahifalari har bir maydonni sanab beradi.

Chat Completions

OpenAI SDK'dan kelganda

• Base URL'ni https://api.shannon-ai.com/v1ga, kalitni esa Shannon kalitingizga o'rnating. Shunda Chat Completions va Responses chaqiruvlari SDK bilan o'z holicha ishlaydi.
• model Shannon id'si bo'lishi kerak. Boshqa provayderning model nomiga, masalan gpt-4oga, 400 va unknown model bilan javob beriladi.
• Mulohaza o'z maydonida keladi: content yonida reasoning_content, xabarda va oqim deltalarida.
• Oqim usageni doim oxirgi chunk'da, finish_reason bilan birga olib keladi.
• Oqimdagi tool chaqiruvi to'liq arguments satri bilan bitta chunk sifatida keladi.
• Javobda bitta choice bor.
• OpenAI API'ning yuqoridagi jadvalda yo'q yo'llariga, masalan /v1/embeddingsga, 404 bilan javob beriladi.

Anthropic SDK'dan kelganda

• Base URL'ni https://api.shannon-ai.comga, /v1siz, kalitni esa Shannon kalitingizga o'rnating. SDK uni x-api-key sifatida yuboradi.
• model Shannon id'si bo'lishi kerak.
• Bu API'da max_tokens ixtiyoriy. Uning standart qiymati 4,096.
• Javob thinking, text va tool_use turidagi kontent bloklarini o'z ichiga oladi. Birinchi blok doim matn emas: bloklarni type bo'yicha tanlang.
• stop_reason — end_turn yoki tool_use. Shannon modeli oqimi max_tokens bilan ham tugashi mumkin.
• anthropic-version va anthropic-beta qabul qilinadi, shuning uchun SDK o'zgarishsiz ishlaydi. So'rovga ular shart emas.
• /v1/messages dagi xatolar Anthropic shaklida: {"type": "error", "error": {…}}.

Bu formatlarda gaplashadigan kodlash vositalari xuddi shunday sozlanadi: base URL, kalit va model sifatida Shannon id'si. CLI kodlash vositalari