Nchịkọta

Endpoints

Endpoint ọ bụla dị n'okpuru otu base URL ma a na-eje ya ozi site na HTTPS.

https://api.shannon-ai.com

Endpoints atọ na-emepụta text na-eru otu models. Họrọ nke format ya koodu gị na-eji ugbu a.

Ihe ndabere nke request

• Body nke POST ọ bụla bụ otu JSON object, ruo 32 MiB.
• Field API na-amaghị anaghị akpata njehie ma ọ nweghị mmetụta. Request e dere maka onye na-enye ọrụ ọzọ anaghị ada n'ihi field ọzọ.
• A na-aza field amaara nwere JSON type na-ezighi ezi, ma ọ bụ field chọrọ achọrọ nke na-adịghị, na 422. A na-aza body na-abụghị JSON ziri ezi na 400.
• model bụ otu n'ime ids dị na Models & pricing. Mkpụrụedemede nta na nnukwu adịghị mkpa.

Azịza bụ JSON, ma ọ bụ stream nke server-sent events mgbe request tọrọ stream na true. Endpoint ọ bụla na-aza n'format nke ya. Azịza ọ bụla nwere header x-request-id.

Ihe request na-agafe

A na-elele request n'usoro kwụsiri ike tupu model agba. Nlele mbụ dara na-aza, ya mere 401 anaghị agwa gị ihe ọ bụla gbasara body.

Ụdị njehie

Njehie bụ JSON object nwere error na-ejide type na message. /v1/messages na-ekechi ya dị ka Anthropic SDKs na-atụ anya; path ọ bụla ọzọ na-eji ụdị OpenAI.

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

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

• Gụọ type na message. code na param dị na ụfọdụ njehie naanị: lee ha dị ka nhọrọ. param bụ null mgbe niile.
• Mgbe stream malitechara, status bụ 200 ugbu a. Ọdịda mgbe ahụ na-abịa dị ka error frame n'ime stream.
• Azịza njehie ọ bụla na-ebu header x-request-id.

Njikwa njehie

Billing na balance

• Enwere otu balance maka akaụntụ, chat na API na-ekekọrịta ya: plan allowance nke taa buru ụzọ, wee purchased credit. API enweghị quota nke ya.
• Request na-edebe output budget ya (max_tokens, default 4,096) ma a na-akwụ ụgwọ maka tokens o jiri n'ezie, na ọnụahịa model.
• Azịza ọ bụla na-akọ ọnụọgụ tokens ya na usage. Peeji Keys & usage na-egosi balance na ihe request ọ bụla na-efu.
• A na-ejere request ọ bụla otu aka. Naanị oke maka ọnụego request bụ flood protection: requests 120 n'otu nkeji maka akaụntụ. Requests e zipụrụ n'otu oge na-eche n'ahịrị.

Limits na balance Models & ọnụahịa Keys & usage

Fields na-adabere na model

Model ọ bụla na-anara otu request. Ole na ole fields na-arụ ọrụ na ụfọdụ models naanị; tebụl na-akpọ ebe. Peeji endpoint na-depụta field ọ bụla.

Chat Completions

Mgbe ị si na OpenAI SDK bịa

• Tọọ base URL na https://api.shannon-ai.com/v1 na key na Shannon key gị. Calls Chat Completions na Responses mgbe ahụ na-arụ ọrụ na SDK dị ka ọ dị.
• model ga-abụ Shannon id. A na-aza aha model nke onye na-enye ọrụ ọzọ, dị ka gpt-4o, na 400 na unknown model.
• Reasoning na-abịa n'field nke ya: reasoning_content n'akụkụ content, n'ozi na n'stream deltas.
• Stream na-ebu usage mgbe niile na chunk ikpeazụ ya, ya na finish_reason.
• Tool call n'stream na-abịa dị ka otu chunk nwere string arguments zuru ezu.
• Azịza nwere otu choice.
• A na-aza paths nke OpenAI API ndị na-adịghị na tebụl dị n'elu, dị ka /v1/embeddings, na 404.

Mgbe ị si na Anthropic SDK bịa

• Tọọ base URL na https://api.shannon-ai.com, na-enweghị /v1, na key na Shannon key gị. SDK na-ezipu ya dị ka x-api-key.
• model ga-abụ Shannon id.
• max_tokens bụ nhọrọ na API a. Default ya bụ 4,096.
• Azịza nwere content blocks nke ụdị thinking, text na tool_use. Block mbụ abụghị text mgbe niile: họrọ blocks site na type.
• stop_reason bụ end_turn ma ọ bụ tool_use. Stream nke Shannon model nwekwara ike ịgwụ na max_tokens.
• A na-anabata anthropic-version na anthropic-beta, ya mere SDK na-arụ ọrụ na-enweghị mgbanwe. Request achọghị ha.
• Njehie na /v1/messages nwere ụdị Anthropic: {"type": "error", "error": {…}}.

A na-edozi coding tools na-asụ formats ndị a n'otu ụzọ: base URL, key, na Shannon id dị ka model. Ngwa CLI maka coding