Ro-shealladh

Endpoints

Tha gach endpoint fon aon base URL agus thèid a fhrithealadh thar HTTPS.

https://api.shannon-ai.com

Ruigidh na trì endpoints a thoirt a-mach teacsa na h-aon mhodailean. Tagh am fear aig a bheil an cruth a chleachdas an còd agad mar-thà.

Bun-bheachdan iarrtais

• Is e aon nì JSON bodhaig gach POST, suas gu 32 MiB.
• Chan eil raon nach aithnich an API a’ cur mearachd air adhart agus chan eil buaidh aige. Chan fhàilnich iarrtas a chaidh a sgrìobhadh airson solaraiche eile air sgàth raon a bharrachd.
• Thèid raon aithnichte le seòrsa JSON ceàrr, no raon riatanach a tha a dhìth, a fhreagairt le 422. Thèid bodhaig nach eil JSON dligheach a fhreagairt le 400.
• Tha model na aon dhe na ids air Models & pricing. Chan eil e gu diofar litrichean mòra no beaga.

Is e JSON a th’ ann am freagairt, no stream de server-sent events nuair a shuidhicheas an t-iarrtas stream gu true. Freagraidh gach endpoint na chruth fhèin. Tha an header x-request-id aig gach freagairt.

Na thèid iarrtas troimhe

Thèid iarrtas a sgrùdadh ann an òrdugh stèidhichte mus ruith modail. Freagraidh a’ chiad sgrùdadh a dh’fhailicheas, agus mar sin chan innis 401 dad dhut mun bhodhaig fhathast.

Cumadh na mearachd

Is e nì JSON le error a th’ ann am mearachd anns a bheil type agus message. Pasgaidh /v1/messages e mar a tha SDKan Anthropic a’ sùileachadh; cleachdaidh gach slighe eile cruth OpenAI.

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

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

• Leugh type agus message. Tha code agus param an làthair air cuid de mhearachdan a-mhàin: làimhsich iad mar roghainneil. Tha param null an-còmhnaidh.
• Às dèidh dha stream tòiseachadh, tha an staid 200 mar-thà. Thig fàilligeadh an uair sin mar fhrèam mearachd am broinn an stream.
• Tha an header x-request-id aig gach freagairt mearachd.

Làimhseachadh mearachd

Billeadh agus balance

• Tha aon bhalance ann airson gach cunntas, agus bidh còmhradh agus API ga roinn: cuibhreann plana an-diugh an toiseach, an uair sin creideas a cheannaich thu. Chan eil cuota fhèin aig an API.
• Glèidhidh iarrtas a bhuidseat output (max_tokens, bun-roghainn 4,096) agus thèid a chosg an uair sin airson na tokens a chleachd e dha-rìribh, aig prìs a’ mhodail.
• Bheir gach freagairt cunntas air na cunntasan token aige ann an usage. Seallaidh an duilleag Keys & usage am balance agus dè a chosg gach iarrtas.
• Thèid gach iarrtas a fhrithealadh co-ionnan. Is e an aon chrìoch air ìre iarrtasan dìon thar-thuiltidh: 120 iarrtas gach mionaid gach cunntais. Fuirichidh iarrtasan a thèid a chur ann an co-shìnte sa chiudha.

Crìochan agus balance Modailean & prìsean Iuchraichean & cleachdadh

Raointean a tha an urra ris a’ mhodail

Gabhaidh gach modail an t-aon iarrtas. Bidh buaidh aig beagan raointean air cuid de mhodailean a-mhàin; ainmichidh an clàr càite. Liostaidh duilleagan nan endpoints gach raon.

Chat Completions

Ma thig thu o OpenAI SDK

• Suidhich am base URL gu https://api.shannon-ai.com/v1 agus an iuchair gu d’ iuchair Shannon. Obraichidh gairmean Chat Completions agus Responses an uair sin leis an SDK mar a tha e.
• Feumaidh model a bhith na id Shannon. Thèid ainm modail solaraiche eile, leithid gpt-4o, a fhreagairt le 400 agus unknown model.
• Thig reusanachadh ann an raon fa leth: reasoning_content ri taobh content, san teachdaireachd agus ann an deltas an stream.
• Bidh usage aig stream an-còmhnaidh anns a’ chunk mu dheireadh, còmhla ri finish_reason.
• Thig gairm inneil ann an stream mar aon chunk leis an t-sreang arguments slàn.
• Tha aon roghainn ann am freagairt.
• Thèid slighean dhen API OpenAI nach eil sa chlàr gu h-àrd, leithid /v1/embeddings, a fhreagairt le 404.

A’ tighinn o SDK Anthropic

• Suidhich am base URL gu https://api.shannon-ai.com, gun /v1, agus an iuchair gu d’ iuchair Shannon. Cuiridh an SDK i mar x-api-key.
• Feumaidh model a bhith na id Shannon.
• Tha max_tokens roghainneil air an API seo. Is e 4,096 a’ bhun-roghainn.
• Tha blocaichean susbaint den t-seòrsa thinking, text agus tool_use ann am freagairt. Chan e an teacsa a’ chiad bhloc an-còmhnaidh: tagh blocaichean a-rèir type.
• Is e stop_reason end_turn no tool_use. Faodaidh stream de mhodail Shannon crìochnachadh le max_tokens cuideachd.
• Thèid anthropic-version agus anthropic-beta aontachadh, agus mar sin obraichidh an SDK gun atharrachadh. Chan eil feum air iarrtas orra.
• Tha cruth Anthropic aig mearachdan air /v1/messages: {"type": "error", "error": {…}}.

Tha innealan còdachaidh a bhruidhneas na cruthan seo air an suidheachadh san aon dòigh: base URL, iuchair, agus id Shannon mar am modail. Innealan còdachaidh CLI