Тойм

Endpoint-ууд

Endpoint бүр нэг үндсэн URL дор байх бөгөөд HTTPS-ээр үйлчилнэ.

https://api.shannon-ai.com

Текст үүсгэдэг гурван endpoint ижил загваруудад хүрнэ. Таны код аль форматыг аль хэдийн ашигладаг бол түүнийг сонгоно уу.

Хүсэлтийн үндэс

• POST бүрийн body нь 32 MiB хүртэлх нэг JSON объект.
• API-ийн мэдэхгүй талбар алдаа үүсгэхгүй, нөлөө ч үзүүлэхгүй. Өөр үйлчилгээ үзүүлэгчид зориулж бичсэн хүсэлт илүү талбараас болж амжилтгүй болохгүй.
• Мэдэгдэж буй талбар JSON төрөл буруу, эсвэл шаардлагатай талбар байхгүй бол 422-оор хариулна. Хүчинтэй JSON биш body-д 400-аар хариулна.
• model нь Models & pricing дээрх id-ийн нэг. Том, жижиг үсэг хамаагүй.

Хариу нь JSON, эсвэл хүсэлт stream-ийг true болгосон үед server-sent events stream. Endpoint бүр өөрийн форматаар хариулна. Хариу бүр x-request-id header-тэй.

Хүсэлт юуг давдаг

Загвар ажиллахаас өмнө хүсэлтийг тогтсон дарааллаар шалгана. Амжилтгүй болсон эхний шалгалт хариулах тул 401 нь body-ийн талаар одоохондоо юу ч хэлэхгүй.

Алдааны бүтэц

Алдаа нь 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.
• Stream эхэлсний дараа статус аль хэдийн 200 байна. Дараа нь гарсан алдаа stream доторх алдааны frame хэлбэрээр ирнэ.
• Алдааны хариу бүр x-request-id header-тэй.

Алдаа боловсруулах

Төлбөр ба үлдэгдэл

• Бүртгэл бүрт нэг үлдэгдэл байх бөгөөд чат ба API хуваалцана: эхлээд өнөөдрийн төлөвлөгөөний эрх, дараа нь худалдаж авсан зээл. API-д өөрийн квот байхгүй.
• Хүсэлт гаралтын төсвөө (max_tokens, үндсэн утга 4,096) нөөцөлж, дараа нь бодитоор ашигласан токеныг загварын үнээр тооцно.
• Хариу бүр токены тоогоо usage-д мэдээлнэ. Keys & usage хуудас үлдэгдэл ба хүсэлт бүрийн зардлыг харуулна.
• Хүсэлт бүрт тэгш үйлчилнэ. Хүсэлтийн хурдны цорын ганц хязгаар нь flood protection: бүртгэл тутамд минутад 120 хүсэлт. Зэрэг илгээсэн хүсэлтүүд дараалалд хүлээнэ.

Хязгаар ба үлдэгдэл Загвар ба үнэ Түлхүүр ба хэрэглээ

Загвараас хамаарах талбарууд

Загвар бүр ижил хүсэлт авна. Цөөн талбар зарим загвар дээр л үйлчилнэ; хүснэгт хаана болохыг нэрлэнэ. 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-оор хариулна.
• Reasoning тусдаа талбарт ирнэ: мессеж болон stream delta-д content-ийн хажууд reasoning_content.
• Stream сүүлийн chunk-даа finish_reason-ийн хамт usage-ийг үргэлж агуулна.
• Stream дэх tool дуудлага бүрэн arguments string-тэй нэг chunk болон ирнэ.
• Хариу нэг choice агуулна.
• Дээрх хүснэгтэд байхгүй OpenAI API-ийн замууд, жишээлбэл /v1/embeddings, 404-өөр хариулна.

Anthropic SDK-аас ирж байгаа бол

• Үндсэн URL-ийг /v1-гүй https://api.shannon-ai.com болгож, түлхүүрийг өөрийн Shannon түлхүүр болгоно уу. SDK үүнийг x-api-key болгон илгээнэ.
• model нь Shannon id байх ёстой.
• Энэ API дээр max_tokens заавал биш. Үндсэн утга 4,096.
• Хариу thinking, text, tool_use төрлийн content block агуулна. Эхний block нь үргэлж текст биш: block-уудыг type-аар сонгоно уу.
• stop_reason нь end_turn эсвэл tool_use. Shannon загварын stream max_tokens-оор бас дуусч болно.
• anthropic-version ба anthropic-beta-г хүлээн авдаг тул SDK өөрчлөлтгүй ажиллана. Хүсэлтэд тэдгээр шаардлагагүй.
• /v1/messages дээрх алдаа Anthropic хэлбэртэй: {"type": "error", "error": {…}}.

Эдгээр форматаар ажилладаг coding хэрэгслүүдийг адилхан тохируулна: үндсэн URL, түлхүүр, загвар болгон Shannon id. CLI кодчилолын хэрэгслүүд