Шолу

Endpoint-тер

Әр endpoint бір базалық URL астында тұрады және HTTPS арқылы беріледі.

https://api.shannon-ai.com

Мәтін шығаратын үш endpoint бір модельдерге жетеді. Кодыңыз қазірдің өзінде қолданатын форматтағысын таңдаңыз.

Сұраудың негіздері

• Әр POST денесі — 32 MiB-қа дейінгі бір JSON нысаны.
• API білмейтін өріс қате тудырмайды және әсер етпейді. Басқа провайдерге арналып жазылған сұрау артық өріс үшін сәтсіз болмайды.
• JSON түрі қате белгілі өріс немесе жоқ міндетті өріс 422 жауабын алады. Жарамды JSON емес денеге 400 жауап беріледі.
• model — «Модельдер және бағалар» бетіндегі id-лердің бірі. Бас және кіші әріптің маңызы жоқ.

Жауап — JSON, немесе сұрау stream мәнін true етіп орнатса, server-sent events стримі. Әр endpoint өз форматында жауап береді. Әр жауапта x-request-id тақырыбы бар.

Сұрау нені өтеді

Сұрау модель іске қосылмай тұрып бекітілген ретпен тексеріледі. Сәтсіз болған бірінші тексеру жауап береді, сондықтан 401 дене туралы әлі ештеңе айтпайды.

Қате пішіні

Қате — type және message бар error өрісі бар JSON нысаны. /v1/messages оны Anthropic SDK-лары күткендей орайды; әр басқа жол OpenAI пішінін қолданады.

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

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

• type және message оқыңыз. code және param тек кейбір қателерде болады: оларды міндетті емес деп санаңыз. param әрқашан null.
• Стрим басталғаннан кейін мәртебе қазірдің өзінде 200. Ақау сонда стрим ішінде қате кадры ретінде келеді.
• Әр қате жауабы x-request-id тақырыбын алып жүреді.

Қателерді өңдеу

Төлем және баланс

• Аккаунтқа бір баланс бар, чат пен API оны бірге пайдаланады: алдымен бүгінгі жоспар лимиті, содан кейін сатып алынған кредит. API-дің өз квотасы жоқ.
• Сұрау өзінің шығыс бюджетін (max_tokens, әдепкі 4,096) резервтейді, содан кейін нақты жұмсаған токендері үшін модель бағасымен есептеледі.
• Әр жауап токен санын usage ішінде хабарлайды. Keys & usage беті балансты және әр сұрау қанша тұрғанын көрсетеді.
• Әр сұрау тең қызмет көрсетіледі. Сұрау жиілігінің жалғыз шегі — flood protection: аккаунтқа минутына 120 сұрау. Параллель жіберілген сұраулар кезекте күтеді.

Шектеулер және баланс Модельдер және бағалар Keys & usage

Модельге байланысты өрістер

Әр модель бірдей сұрауды қабылдайды. Кейбір өрістер тек кейбір модельдерде күшіне енеді; кесте қайда екенін атайды. Endpoint беттері әр өрісті тізімдейді.

Chat Completions

OpenAI SDK-дан келгенде

• Базалық URL-ді https://api.shannon-ai.com/v1, ал кілтті Shannon кілтіңіз етіп орнатыңыз. Сонда Chat Completions және Responses шақырулары SDK-мен сол күйінде жұмыс істейді.
• model Shannon id-і болуы керек. gpt-4o сияқты басқа провайдердің модель атына 400 және unknown model жауап беріледі.
• Пайымдау жеке өрісте келеді: content жанында reasoning_content, хабарламада және стрим дельталарында.
• Стрим әрқашан usage мәнін finish_reason мәнімен бірге соңғы бөлікте алып жүреді.
• Стримдегі құрал шақыруы толық arguments жолы бар бір бөлік ретінде келеді.
• Жауапта бір choice бар.
• Жоғарыдағы кестеде жоқ OpenAI API жолдарына, мысалы /v1/embeddings, 404 жауап беріледі.

Anthropic SDK-дан келгенде

• Базалық URL-ді https://api.shannon-ai.com етіп, /v1 жоқ, ал кілтті Shannon кілтіңіз етіп орнатыңыз. SDK оны x-api-key ретінде жібереді.
• model Shannon id-і болуы керек.
• max_tokens бұл API-де міндетті емес. Оның әдепкі мәні 4,096.
• Жауап thinking, text және tool_use түріндегі мазмұн блоктарын қамтиды. Бірінші блок әрқашан мәтін емес: блоктарды type бойынша таңдаңыз.
• stop_reason мәні end_turn немесе tool_use. Shannon моделінің стримі max_tokens мәнімен де аяқталуы мүмкін.
• anthropic-version және anthropic-beta қабылданады, сондықтан SDK өзгеріссіз жұмыс істейді. Сұрауға олар қажет емес.
• /v1/messages бойынша қателер Anthropic пішінінде: {"type": "error", "error": {…}}.

Осы форматтарда сөйлесетін кодтау құралдары дәл солай баптайды: базалық URL, кілт және модель ретінде Shannon id-і. CLI кодтау құралдары