Léim go dtí an t-ábhar
Forbhreathnú

Forbhreathnú

Léarscáil an API: gach críochphointe, cén chuma atá ar iarratas agus ar earráid, conas a íoctar as glaonna, agus cad ba cheart a bheith ar eolas agat nuair a thagann tú ó SDK OpenAI nó Anthropic.

Críochphointí

Tá gach críochphointe faoi URL bonn amháin agus seirbheáiltear thar HTTPS é.

URL bonn
https://api.shannon-ai.com
Críochphointe Formáid Cad chuige é
POST /v1/chat/completions OpenAI Chat Completions Seol comhrá, faigh an chéad fhreagra eile. Le sruthú nó gan sruthú.
POST /v1/messages Anthropic Messages An rud céanna, i gcruthanna iarratais agus freagra SDKanna Anthropic.
POST /v1/responses OpenAI Responses An rud céanna, i gcruthanna Responses. Ní choinníonn an críochphointe aon staid: seol an comhrá le gach iarratas.
GET /v1/models Liosta múnlaí OpenAI Liostaigh na múnlaí le fuinneog comhthéacs, praghsanna agus cumais. Ní theastaíonn eochair.
POST /v1/tokenize Shannon API Comhair token téacs nó iarratais chomhrá do mhúnla open-weight óstáilte. Saor in aisce.
POST /v1/messages/count_tokens Comhaireamh token Anthropic Comhair token ionchuir iarratais Messages do mhúnla open-weight óstáilte. Saor in aisce.

Sroicheann na trí chríochphointe a tháirgeann téacs na múnlaí céanna. Roghnaigh an ceann a n-úsáideann do chód a fhormáid cheana.

Bunghnéithe iarratais

Ceanntásc Cur síos
Authorization: Bearer <key> D'eochair API. Riachtanach ar gach críochphointe seachas GET /v1/models, mura seolann tú x-api-key.
x-api-key: <key> An eochair chéanna sa cheanntásc a sheolann SDKanna Anthropic. Léitear é ar gach críochphointe.
Content-Type: application/json Riachtanach ar gach POST. Gan é is 415 an freagra.
x-request-id: <your id> Roghnach. D'id féin don iarratas; filleann sé i gceanntásc an fhreagra x-request-id. Gan é cruthaíonn an API ceann de 12 charachtar heicsidheachúlacha.
  • Is réad JSON amháin é corp gach POST, suas le 32 MiB.
  • Ní chruthaíonn réimse nach bhfuil aithne ag an API air aon earráid agus níl aon éifeacht aige. Ní theipeann ar iarratas a scríobhadh do sholáthraí eile mar gheall ar réimse breise.
  • Freagraítear réimse aitheanta le cineál JSON mícheart, nó réimse riachtanach ar iarraidh, le 422. Freagraítear corp nach JSON bailí é le 400.
  • Is ceann de na hids ar Mhúnlaí agus praghsáil é model. Is cuma litreacha móra nó beaga.

Is JSON é freagra, nó sruth imeachtaí a sheoltar ón bhfreastalaí nuair a shocraíonn an t-iarratas stream go true. Freagraíonn gach críochphointe ina fhormáid féin. Tá an ceanntásc x-request-id ar gach freagra.

An rud a théann iarratas tríd

Seiceáiltear iarratas in ord seasta sula ritheann múnla. Freagraíonn an chéad seiceáil a theipeann, mar sin ní insíonn 401 aon rud duit faoin gcorp go fóill.

Cruth na n-earráidí

Is réad JSON é earráid le error a bhfuil type agus message ann. Fillteann /v1/messages í mar a bhíonn súil ag SDKanna Anthropic leis; úsáideann gach cosán eile cruth OpenAI.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}
  • Léigh type agus message. Tá code agus param ar roinnt earráidí amháin: caith leo mar roghnach. Is null i gcónaí é param.
  • Tar éis do shruth tosú, is 200 an stádas cheana. Tagann teip ansin mar fhráma earráide laistigh den sruth.
  • Iompraíonn gach freagra earráide an ceanntásc x-request-id.
Stádas Cineál Cathain
400 invalid_request_error Níl JSON bailí sa chorp, níl aithne ar id an mhúnla, nó ní ghlacann an múnla le cineál ionchuir a sheol tú.
401 authentication_error Tá an eochair ar iarraidh nó níl sí bailí.
404 not_found_error Níl an cosán ann.
405 api_error Tá an cosán ann, ach tá an modh mícheart.
413 invalid_request_error Tá an corp níos mó ná 32 MiB.
415 invalid_request_error Ní application/json é Content-Type.
422 invalid_request_error Tá cineál JSON mícheart ar réimse, nó tá réimse riachtanach ar iarraidh.
429 rate_limit_error Ní chlúdaíonn an t-iarmhéid an t-iarratas, tháinig níos mó ná 120 iarratas isteach in aon nóiméad amháin, úsáideadh suas glaonna Shannon Coder na fuinneoige, nó tá an múnla gnóthach. Insíonn an teachtaireacht cé acu.
5xx api_error Stádas 500, 502, 503 nó 504: bhí an t-iarratas bailí ach níorbh fhéidir freagra a thabhairt air. Seol arís é. Is féidir an cineál server_error a bheith ar 500.

Láimhseáil Earráide

Billeáil agus iarmhéid

  • Tá iarmhéid amháin ann in aghaidh an chuntais, agus roinneann comhrá agus API é: liúntas an phlean don lá inniu ar dtús, ansin creidmheas ceannaithe. Níl cuóta dá chuid féin ag an API.
  • Cuireann iarratas a bhuiséad aschuir (max_tokens, réamhshocrú 4,096) in áirithe agus ansin muirearaítear air na token a d'úsáid sé i ndáiríre, ar phraghas an mhúnla.
  • Tuairiscíonn gach freagra a chomhaireamh token in usage. Taispeánann an leathanach Eochracha agus úsáid an t-iarmhéid agus cad a chosain gach iarratas.
  • Freastalaítear ar gach iarratas ar an gcaoi chéanna. Is é cosaint tuile an t-aon teorainn ar ráta iarratas: 120 iarratas in aghaidh an nóiméid in aghaidh an chuntais. Fanann iarratais a sheoltar comhthreomhar sa scuaine.

Teorainneacha agus iarmhéid Múnlaí agus praghsáil Eochracha agus úsáid

Réimsí a bhraitheann ar an múnla

Glacann gach múnla leis an iarratas céanna. Tagann cúpla réimse i bhfeidhm ar roinnt múnlaí amháin; ainmníonn an tábla cá háit. Liostaíonn leathanaigh na gcríochphointí gach réimse.

Réimse Cur síos Curtha i bhfeidhm ag
system Treoracha don mhúnla: teachtaireacht system ar Chat Completions, system ar Messages, instructions ar Responses. Múnlaí open-weight óstáilte, shannon-1.6-*, shannon-2-*, shannon-coder-1
temperature Teocht samplála. Múnlaí open-weight óstáilte, shannon-1.6-*, shannon-coder-1
top_p Samplail núicléis. Múnlaí open-weight óstáilte
seed Síol seasta don samplail. Múnlaí open-weight óstáilte
stop Suas le 4 sheicheamh stoptha. Múnlaí open-weight óstáilte
reasoning_effort Cé mhéad a dhéanann an múnla réasúnaíocht sula bhfreagraíonn sé. reasoning.effort ar Responses, thinking ar Messages. Múnlaí open-weight óstáilte
web_search Ligeann true don mhúnla cuardach a dhéanamh ar an ngréasán don iarratas seo. Réimse den API seo, ar Chat Completions agus Messages. Múnlaí Shannon seachas shannon-coder-1
max_tokens An buiséad aschuir. Ar gach múnla socraíonn sé an méid a chuirtear in áirithe as d'iarmhéid. Mar theorainn ar fhad an fhreagra: múnlaí open-weight óstáilte, shannon-1.6-*, shannon-coder-1

Chat Completions

Ag teacht ó SDK de chuid OpenAI

  • Socraigh an URL bonn go https://api.shannon-ai.com/v1 agus an eochair go d'eochair Shannon. Ansin oibríonn glaonna Chat Completions agus Responses leis an SDK mar atá.
  • Caithfidh model a bheith ina id Shannon. Freagraítear ainm múnla soláthraí eile, mar gpt-4o, le 400 agus unknown model.
  • Tagann réasúnaíocht i réimse dá cuid féin: reasoning_content in aice le content, sa teachtaireacht agus i deltaí an tsrutha.
  • Iompraíonn sruth usage ina phíosa deireanach i gcónaí, in éineacht le finish_reason.
  • Tagann glao uirlise i sruth mar phíosa amháin leis an tsreang arguments iomlán.
  • Tá rogha amháin i bhfreagra.
  • Freagraítear cosáin den API OpenAI nach bhfuil sa tábla thuas, mar /v1/embeddings, le 404.

Ag teacht ó SDK Anthropic

  • Socraigh an URL bonn go https://api.shannon-ai.com, gan /v1, agus an eochair go d'eochair Shannon. Seolann an SDK mar x-api-key í.
  • Caithfidh model a bheith ina id Shannon.
  • Tá max_tokens roghnach ar an API seo. Is é 4,096 a réamhshocrú.
  • Tá bloic ábhair den chineál thinking, text agus tool_use i bhfreagra. Ní hé an téacs an chéad bhloc i gcónaí: roghnaigh bloic de réir type.
  • Is é stop_reason end_turn nó tool_use. Is féidir le sruth de mhúnla Shannon deireadh le max_tokens freisin.
  • Glactar le anthropic-version agus anthropic-beta, mar sin oibríonn an SDK gan athrú. Ní theastaíonn siad ó iarratas.
  • Tá cruth Anthropic ar earráidí ar /v1/messages: {"type": "error", "error": {…}}.

Socraítear uirlisí códaithe a labhraíonn na formáidí seo ar an mbealach céanna: URL bonn, eochair, agus id Shannon mar an múnla. Uirlisí CLI códaithe