Tirohanga whānui

Ngā endpoint

Kei raro i te base URL kotahi ia endpoint, ā, ka ratoa mā te HTTPS.

https://api.shannon-ai.com

Ka tae ngā endpoint e toru e whakaputa kuputuhi ana ki ngā model ōrite. Kōwhiria te mea ka whakamahi tō waehere i tōna hōputu kē.

Ngā kaupapa tuatahi o te tono

• Ko te tinana o ia POST he ahanoa JSON kotahi, tae atu ki te 32 MiB.
• Kāore he hapa i tētahi āpure kāore e mōhiotia e te API, ā, kāore he pānga. Kāore e rahua tētahi tono i tuhia mō tētahi atu kaiwhakarato mō tētahi āpure tāpiri.
• Ka whakautua tētahi āpure e mōhiotia ana me te momo JSON hē, tētahi āpure e hiahiatia ana kua ngaro rānei, ki te 422. Ka whakautua tētahi tinana ehara i te JSON tika ki te 400.
• Ko te model tētahi o ngā id i Models & pricing. Kāore e pā te pū nui, pū iti rānei.

He JSON te whakautu, he stream rānei o ngā server-sent events ina tautuhi te tono i te stream ki te true. Ka whakautu ia endpoint i tōna ake hōputu. Kei ia whakautu te header x-request-id.

Ngā mea e whiti ai tētahi tono

Ka tirohia tētahi tono i tētahi raupapa pūmau i mua i te rere o tētahi model. Ko te tirohanga tuatahi ka rahua te whakautu, nō reira kāore tētahi 401 e kī i tētahi mea mō te tinana.

Te āhua o te hapa

He ahanoa JSON te hapa me tētahi error e kawe ana i te type me te message. Ka takai te /v1/messages i a ia pēnei i ta ngā SDK Anthropic e tūmanako ai; ka whakamahi ia ara kē atu i te āhua OpenAI.

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

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

• Pānuitia te type me te message. Kei ētahi hapa anake te code me te param: whakaarohia he kōwhiringa. Ko null tonu te param.
• I muri i te tīmatanga o tētahi stream, ko 200 kē te tūnga. Ka tae mai tētahi rahua i reira hei frame hapa i roto i te stream.
• Ka kawe ia whakautu hapa i te header x-request-id.

Whakahaere hapa

Te utu me te toenga

• Kotahi te toenga mō ia pūkete, ā, ka tiritiri te chat me te API: te whakaaetanga o te mahere mō tēnei rā i te tuatahi, kātahi ko te nama kua hokona. Kāore he quota ake tā te API.
• Ka pupuri tētahi tono i tana tahua output (max_tokens, taunoa 4,096), ā, ka utua ia mō ngā token i whakamahia tūturutia e ia, ki te utu a te model.
• Ka pūrongo ia whakautu i ōna tatau token i te usage. Ka whakaatu te whārangi Keys & usage i te toenga me te utu o ia tono.
• Ka ratoa ia tono i te ōrite. Ko te tepe anake mō te tere tono ko te flood protection: 120 tono ia meneti mō ia pūkete. Ka tatari ngā tono e tukuna whakarara ana i te rārangi.

Ngā tepe me te toenga Ngā model me ngā utu Keys & usage

Ngā āpure e whakawhirinaki ana ki te model

Ka whakaae ia model ki te tono ōrite. Ka whai pānga ētahi āpure ki ētahi model anake; ka whakaingoa te ripanga i te wāhi. Ka rārangi ngā whārangi endpoint i ia āpure.

Chat Completions

Ina haere mai koe i tētahi SDK OpenAI

• Tautuhia te base URL ki te https://api.shannon-ai.com/v1 me te key ki tō key Shannon. Kātahi ka mahi ngā karanga Chat Completions me Responses ki te SDK pēnei i a ia.
• Me id Shannon te model. Ka whakautua te ingoa model o tētahi atu kaiwhakarato, pēnei i te gpt-4o, ki te 400 me te unknown model.
• Ka tae mai te reasoning i tētahi āpure motuhake: reasoning_content i te taha o te content, i te karere me ngā delta stream.
• Ka kawe tētahi stream i te usage i tōna chunk whakamutunga i ngā wā katoa, i te taha o te finish_reason.
• Ka tae mai tētahi karanga tool i roto i tētahi stream hei chunk kotahi me te aho arguments katoa.
• Kotahi te kōwhiringa o tētahi whakautu.
• Ka whakautua ngā ara o te API OpenAI kāore i te ripanga i runga ake nei, pēnei i te /v1/embeddings, ki te 404.

Ina haere mai koe i tētahi SDK Anthropic

• Tautuhia te base URL ki te https://api.shannon-ai.com, kāore he /v1, me te key ki tō key Shannon. Ka tukuna e te SDK hei x-api-key.
• Me id Shannon te model.
• He kōwhiringa te max_tokens i tēnei API. Ko tōna taunoa 4,096.
• Kei tētahi whakautu ngā poraka content o te momo thinking, text me tool_use. Ehara i te kuputuhi i ngā wā katoa te poraka tuatahi: kōwhiria ngā poraka mā te type.
• Ko te stop_reason ko end_turn ko tool_use rānei. Ka taea hoki te mutu o tētahi stream o tētahi model Shannon me te max_tokens.
• E whakaaetia ana te anthropic-version me te anthropic-beta, nō reira ka mahi te SDK kāore i huri. Kāore e hiahiatia e tētahi tono.
• Ko ngā hapa i runga i te /v1/messages he āhua Anthropic: {"type": "error", "error": {…}}.

Ka whakaritea ngā taputapu whakawaehere e kōrero ana i ēnei hōputu i te ara ōrite: base URL, key, me tētahi id Shannon hei model. Ngā taputapu CLI mō te tuhi code