Dubawa

Endpoints

Kowane endpoint yana ƙarƙashin base URL ɗaya kuma ana yi masa hidima ta HTTPS.

https://api.shannon-ai.com

Endpoints uku da ke samar da rubutu suna isa ga models iri ɗaya. Ku zaɓi wanda tsarinsa code ɗinku ke amfani da shi tuni.

Muhimman abubuwan request

• Jikin kowane POST JSON object ɗaya ne, har zuwa 32 MiB.
• Field da API bai sani ba ba ya haifar da kuskure kuma ba ya da tasiri. Request da aka rubuta wa wani provider ba ya gazawa saboda ƙarin field.
• Field da aka sani mai nau'in JSON mara kyau, ko field da ake buƙata da ya ɓace, ana amsa shi da 422. Jiki wanda ba JSON mai inganci ba ana amsa shi da 400.
• model ɗaya ne daga ids da ke Models & farashi. Manyan haruffa da ƙanana ba su da muhimmanci.

Amsa JSON ce, ko stream na server-sent events idan request ya saita stream zuwa true. Kowane endpoint yana amsawa a tsarinsa. Kowace amsa tana da header x-request-id.

Abin da request ke wucewa

Ana duba request bisa tsari tsayayye kafin model ya gudana. Binciken farko da ya gaza shi ke amsawa, don haka 401 bai gaya muku komai game da jiki tukuna ba.

Siffar kuskure

Kuskure JSON object ne mai error wanda ke ɗauke da type da message. /v1/messages yana nannaɗe shi yadda Anthropic SDKs ke tsammani; kowace sauran hanya tana amfani da siffar OpenAI.

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

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

• Ku karanta type da message. code da param suna nan a wasu kurakurai kaɗai: ku ɗauke su a matsayin zaɓi. param koyaushe null ne.
• Bayan stream ya fara, matsayin ya riga ya zama 200. Gazawa sai ta zo a matsayin error frame a cikin stream.
• Kowace amsar kuskure tana ɗauke da header x-request-id.

Kuskuren Gudanarwa

Biyan kuɗi da balance

• Akwai balance ɗaya ga kowane asusu, kuma taɗi da API suna raba shi: plan allowance na yau da farko, sannan credit da aka saya. API ba shi da quota na kansa.
• Request yana ware output budget ɗinsa (max_tokens, na asali 4,096) sannan a caje shi don tokens da ya yi amfani da su da gaske, a farashin model.
• Kowace amsa tana bayyana ƙirgan tokens ɗinta a usage. Shafin Maɓallai & amfani yana nuna balance da abin da kowace request ta kashe.
• Ana yi wa kowace request hidima daidai. Iyaka ɗaya tilo kan yawan requests ita ce flood protection: requests 120 a minti ɗaya ga kowane asusu. Requests da aka aika a lokaci guda suna jira a layi.

Iyakoki da balance Models & farashi Maɓallai & amfani

Fields da suka dogara da model

Kowane model yana karɓar request iri ɗaya. Wasu fields suna aiki a wasu models kaɗai; teburin yana faɗin inda. Shafukan endpoints suna lissafa kowane field.

Chat Completions

Idan kuna zuwa daga OpenAI SDK

• Ku saita base URL zuwa https://api.shannon-ai.com/v1 kuma maɓalli zuwa maɓallinku na Shannon. Kiran Chat Completions da Responses sai suna aiki da SDK yadda yake.
• Dole model ya zama id na Shannon. Sunan model na wani provider, kamar gpt-4o, ana amsa shi da 400 da unknown model.
• Reasoning yana zuwa a field na kansa: reasoning_content kusa da content, a saƙo da kuma a stream deltas.
• Stream koyaushe yana ɗauke da usage a chunk ɗinsa na ƙarshe, tare da finish_reason.
• Kiran tool a stream yana zuwa a chunk ɗaya tare da cikakken string na arguments.
• Amsa tana da choice ɗaya.
• Hanyoyin OpenAI API da ba su cikin teburin da ke sama, kamar /v1/embeddings, ana amsa su da 404.

Idan kuna zuwa daga Anthropic SDK

• Ku saita base URL zuwa https://api.shannon-ai.com, ba tare da /v1 ba, kuma maɓalli zuwa maɓallinku na Shannon. SDK yana aika shi a matsayin x-api-key.
• Dole model ya zama id na Shannon.
• max_tokens zaɓi ne a wannan API. Na asali shi ne 4,096.
• Amsa tana ɗauke da content blocks na nau'in thinking, text da tool_use. Block na farko ba koyaushe rubutu ba ne: ku zaɓi blocks ta type.
• stop_reason shi ne end_turn ko tool_use. Stream na model na Shannon na iya ƙarewa da max_tokens ma.
• Ana karɓar anthropic-version da anthropic-beta, don haka SDK yana aiki ba tare da canji ba. Request ba ya buƙatar su.
• Kurakurai a /v1/messages suna da siffar Anthropic: {"type": "error", "error": {…}}.

Ana saita kayan rubuta code da ke magana da waɗannan tsare-tsare iri ɗaya: base URL, maɓalli, da id na Shannon a matsayin model. Kayan CLI na rubuta code