Akopọ

Àwọn endpoint

Gbogbo endpoint wà lábẹ́ base URL kan, a sì ń sìn wọ́n lórí HTTPS.

https://api.shannon-ai.com

Àwọn endpoint mẹ́ta tó ń mú ọ̀rọ̀ jáde ń dé àwọn model kan náà. Yan èyí tí code rẹ ti ń lo ọ̀nà rẹ̀.

Ìpìlẹ̀ ìbéèrè

• Body ti POST kọ̀ọ̀kan jẹ́ object JSON kan, títí dé 32 MiB.
• Field tí API kò mọ̀ kì í fa àṣìṣe kò sì ní ipa. Ìbéèrè tí a kọ fún provider mìíràn kì í kùnà nítorí field àfikún.
• Field tí a mọ̀ pẹ̀lú irú JSON tí kò tọ̀, tàbí field dandan tí kò sí, ni a ń dáhùn pẹ̀lú 422. Body tí kì í ṣe JSON tó tọ̀ ni a ń dáhùn pẹ̀lú 400.
• model jẹ́ ọ̀kan nínú àwọn id lórí Àwọn model àti iye owó. Lẹ́tà ńlá àti kékeré kò ṣe pàtàkì.

Èsì jẹ́ JSON, tàbí stream ti server-sent events nígbà tí ìbéèrè bá ṣètò stream sí true. Endpoint kọ̀ọ̀kan ń dáhùn ní ọ̀nà tirẹ̀. Gbogbo èsì ní header x-request-id.

Ohun tí ìbéèrè ń kọjá

A ń ṣàyẹ̀wò ìbéèrè ní ìlànà tó dúró ṣinṣin kí model tó ṣiṣẹ́. Ìṣàyẹ̀wò àkọ́kọ́ tó bá kùnà ni ó ń dáhùn, nítorí náà 401 kò tíì sọ nǹkankan fún ọ nípa body.

Ìrísí àṣìṣe

Àṣìṣe jẹ́ object JSON pẹ̀lú error tó ní type àti message. /v1/messages ń yí i ká bí àwọn SDK Anthropic ṣe retí; gbogbo path mìíràn ń lo ìrísí OpenAI.

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

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

• Ka type àti message. code àti param wà lórí àwọn àṣìṣe kan nìkan: ka wọ́n sí àṣàyàn. param jẹ́ null nígbà gbogbo.
• Lẹ́yìn tí stream bá ti bẹ̀rẹ̀, status ti jẹ́ 200. Ìkùnà lẹ́yìn náà ń dé bí frame àṣìṣe inú stream.
• Gbogbo èsì àṣìṣe gbé header x-request-id.

Mimu Aṣiṣe

Owó àti balance

• Balance kan wà fún account kọ̀ọ̀kan, chat àti API sì jọ ń lò ó: allowance plan òní ní àkọ́kọ́, lẹ́yìn náà credit tí a rà. API kò ní quota tirẹ̀.
• Ìbéèrè ń fi iye output rẹ̀ pamọ́ (max_tokens, àìyípadà 4,096), a sì ń gba owó àwọn token tó lò nítòótọ́ ní iye owó model.
• Gbogbo èsì ń ròyìn iye token rẹ̀ nínú usage. Ojú-ìwé Àwọn key àti ìlò ń fi balance hàn àti ohun tí ìbéèrè kọ̀ọ̀kan ná.
• A ń sin gbogbo ìbéèrè bákan náà. Ààlà kan ṣoṣo lórí iye ìbéèrè ni ààbò flood: ìbéèrè 120 ní ìṣẹ́jú kan fún account kan. Àwọn ìbéèrè tí a fi ránṣẹ́ ní ìṣọ̀kan ń dúró ní ìlà.

Àwọn ààlà àti balance Àwọn model àti iye owó Àwọn key àti ìlò

Àwọn field tó dá lórí model

Gbogbo model ń gba ìbéèrè kan náà. Àwọn field díẹ̀ ń ṣiṣẹ́ lórí àwọn model kan nìkan; tábìlì náà dárúkọ ibi tí wọ́n wà. Àwọn ojú-ìwé endpoint ṣàkójọ gbogbo field.

Chat Completions

Wíwá láti SDK OpenAI

• Ṣètò base URL sí https://api.shannon-ai.com/v1 àti key sí key Shannon rẹ. Àwọn ìpè Chat Completions àti Responses yóò ṣiṣẹ́ pẹ̀lú SDK bí ó ṣe wà.
• model gbọdọ̀ jẹ́ id Shannon. Orúkọ model ti provider mìíràn, bíi gpt-4o, ni a ń dáhùn pẹ̀lú 400 àti unknown model.
• Ìrònú ń wá nínú field tirẹ̀: reasoning_content lẹ́gbẹ̀ẹ́ content, nínú ìfiránṣẹ́ àti nínú àwọn delta stream.
• Stream máa ń gbé usage nínú chunk rẹ̀ tó gbẹ̀yìn, pẹ̀lú finish_reason.
• Ìpè tool nínú stream ń dé bí chunk kan pẹ̀lú string arguments pípé.
• Èsì ní choice kan.
• Àwọn path ti API OpenAI tí kò sí nínú tábìlì òkè, bíi /v1/embeddings, ni a ń dáhùn pẹ̀lú 404.

Wíwá láti SDK Anthropic

• Ṣètò base URL sí https://api.shannon-ai.com, láìsí /v1, àti key sí key Shannon rẹ. SDK ń fi ránṣẹ́ bí x-api-key.
• model gbọdọ̀ jẹ́ id Shannon.
• max_tokens jẹ́ àṣàyàn lórí API yìí. Iye àìyípadà rẹ̀ jẹ́ 4,096.
• Èsì ní àwọn block àkóónú ti irú thinking, text àti tool_use. Block àkọ́kọ́ kì í ṣe ọ̀rọ̀ nígbà gbogbo: yan àwọn block nípasẹ̀ type.
• stop_reason jẹ́ end_turn tàbí tool_use. Stream ti model Shannon tún lè parí pẹ̀lú max_tokens.
• A gba anthropic-version àti anthropic-beta, nítorí náà SDK ń ṣiṣẹ́ láìyípadà. Ìbéèrè kò nílò wọn.
• Àwọn àṣìṣe lórí /v1/messages ní ìrísí Anthropic: {"type": "error", "error": {…}}.

A ṣètò àwọn coding tool tó ń lo àwọn ọ̀nà wọ̀nyí ní ọ̀nà kan náà: base URL, key, àti id Shannon bí model. Àwọn irinṣẹ́ CLI fún kíkọ code