Шарҳ

Endpoint-ҳо

Ҳар endpoint зери як base URL ҷойгир аст ва тавассути HTTPS хидмат карда мешавад.

https://api.shannon-ai.com

Се endpoint-е, ки матн тавлид мекунанд, ба ҳамон моделҳо дастрасӣ медиҳанд. Яке аз онҳоро интихоб кунед, ки коди шумо аллакай форматашро истифода мебарад.

Асосҳои дархост

• Бадани ҳар POST як объекти JSON аст, то 32 MiB.
• Майдоне, ки API намешиносад, хатогӣ намеорад ва таъсире надорад. Дархости барои провайдери дигар навишташуда аз сабаби майдони иловагӣ ноком намешавад.
• Ба майдони маъруф бо навъи JSON-и нодуруст, ё майдони ҳатмии намерасанда, бо 422 ҷавоб дода мешавад. Ба бадане, ки JSON-и дуруст нест, бо 400 ҷавоб дода мешавад.
• model яке аз id-ҳои Моделҳо ва нархҳо аст. Ҳарфҳои калон ва хурд аҳамият надоранд.

Ҷавоб JSON аст, ё ҷараёни рӯйдодҳои фиристодаи сервер вақте ки дархост stream-ро ба true мегузорад. Ҳар endpoint бо формати худ ҷавоб медиҳад. Ҳар ҷавоб сарлавҳаи x-request-id-ро дорад.

Дархост аз чӣ мегузарад

Дархост пеш аз кори модел бо тартиби собит санҷида мешавад. Аввалин санҷише, ки ноком мешавад, ҷавоб медиҳад, бинобар ин 401 ҳанӯз дар бораи бадан чизе намегӯяд.

Шакли хатогӣ

Хатогӣ объекти JSON бо error аст, ки type ва message-ро дорад. /v1/messages онро ба тарзе мепечонад, ки SDK-ҳои Anthropic интизоранд; ҳар роҳи дигар шакли 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 ҳисобот медиҳад. Саҳифаи Калидҳо ва истифода баланс ва арзиши ҳар дархостро нишон медиҳад.
• Ҳар дархост баробар хидмат карда мешавад. Ягона маҳдудият дар суръати дархост ҳифз аз дархостҳои аз ҳад зиёд аст: 120 дархост дар як дақиқа барои ҳар аккаунт. Дархостҳои мувозӣ дар навбат меистанд.

Маҳдудиятҳо ва баланс Моделҳо ва нархҳо Калидҳо ва истифода

Майдонҳое, ки аз модел вобастаанд

Ҳар модел ҳамон як дархостро қабул мекунад. Чанд майдон танҳо дар баъзе моделҳо амал мекунад; ҷадвал мегӯяд, дар куҷо. Саҳифаҳои endpoint ҳар майдонро номбар мекунанд.

Chat Completions

Омадан аз SDK-и OpenAI

• Base URL-ро ба https://api.shannon-ai.com/v1 ва калидро ба калиди Shannon-и худ танзим кунед. Он гоҳ даъватҳои Chat Completions ва Responses бо SDK ҳамон тавр ки ҳаст, кор мекунанд.
• model бояд id-и Shannon бошад. Ба номи модели провайдери дигар, ба монанди gpt-4o, бо 400 ва unknown model ҷавоб дода мешавад.
• Reasoning дар майдони алоҳида меояд: reasoning_content дар паҳлӯи content, дар паём ва дар deltaҳои ҷараён.
• Ҷараён ҳамеша usage-ро дар чанки охирини худ якҷоя бо finish_reason дорад.
• Даъвати абзор дар ҷараён ҳамчун як чанк бо сатри пурраи arguments меояд.
• Ҷавоб як choice дорад.
• Ба роҳҳои API-и OpenAI, ки дар ҷадвали боло нестанд, ба монанди /v1/embeddings, бо 404 ҷавоб дода мешавад.

Омадан аз SDK-и Anthropic

• Base URL-ро ба https://api.shannon-ai.com, бе /v1, ва калидро ба калиди Shannon-и худ танзим кунед. SDK онро ҳамчун x-api-key мефиристад.
• model бояд id-и Shannon бошад.
• 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": {…}}.

Абзорҳои барномасозие, ки бо ин форматҳо кор мекунанд, ҳамин тавр танзим мешаванд: base URL, калид ва id-и Shannon ҳамчун модел. Абзорҳои CLI барои барномасозӣ