Tlola ho ea ho litaba
Kakaretso

Kakaretso

Mmapa oa API: endpoint e 'ngoe le e 'ngoe, kopo le phoso li shebahala joang, hore na likopo li lefisoa joang, le seo u lokelang ho se tseba ha u tsoa ho SDK ea OpenAI kapa Anthropic.

Li-endpoint

Endpoint e 'ngoe le e 'ngoe e ka tlase ho base URL e le 'ngoe mme e sebeletsoa ka HTTPS.

Base URL
https://api.shannon-ai.com
Endpoint Sebopeho E etselitsoe eng
POST /v1/chat/completions OpenAI Chat Completions Romela moqoqo, u fumane karabo e latelang. Ka streaming kapa ntle le eona.
POST /v1/messages Anthropic Messages Se tšoanang, ka mebopeho ea kopo le karabo ea li-SDK tsa Anthropic.
POST /v1/responses OpenAI Responses Se tšoanang, ka mebopeho ea Responses. Endpoint ha e boloke state: romela moqoqo le kopo e 'ngoe le e 'ngoe.
GET /v1/models Lenane la li-model la OpenAI Thathamisa li-model le context window, litheko le bokhoni. Ha e hloke senotlolo.
POST /v1/tokenize Shannon API Bala tokens tsa mongolo kapa tsa kopo ea chat bakeng sa model e hosted ea open-weight. Ke mahala.
POST /v1/messages/count_tokens Anthropic token count Bala input tokens tsa kopo ea Messages bakeng sa model e hosted ea open-weight. Ke mahala.

Li-endpoint tse tharo tse hlahisang mongolo li fihla ho li-model tse tšoanang. Khetha eo sebopeho sa eona se seng se sebelisoang ke code ea hau.

Metheo ea kopo

Header Tlhaloso
Authorization: Bearer <key> Senotlolo sa hau sa API. E hlokahala ho endpoint e 'ngoe le e 'ngoe ntle le GET /v1/models, ntle le haeba u romela x-api-key.
x-api-key: <key> Senotlolo se tšoanang ho header eo li-SDK tsa Anthropic li e romelang. E baloa ho endpoint e 'ngoe le e 'ngoe.
Content-Type: application/json E hlokahala ho POST e 'ngoe le e 'ngoe. Ntle le eona karabo ke 415.
x-request-id: <your id> Ha e hlokahale. Id ea hau ea kopo; e khutla ho header ea karabo x-request-id. Ntle le eona API e iketsetsa e nang le litlhaku tse 12 tsa hexadecimal.
  • Body ea POST e 'ngoe le e 'ngoe ke ntho e le 'ngoe ea JSON, ho fihlela ho 32 MiB.
  • Field eo API e sa e tsebeng ha e hlahise phoso mme ha e na phello. Kopo e ngotsoeng bakeng sa provider e mong ha e hloleha ka lebaka la field e eketsehileng.
  • Field e tsejoang e nang le mofuta o fosahetseng oa JSON, kapa field e hlokahalang e sieo, e arajoa ka 422. Body eo e seng JSON e nepahetseng e arajoa ka 400.
  • model ke e 'ngoe ea li-id tse leqepheng la Models & pricing. Litlhaku tse kholo le tse nyane ha li bohlokoa.

Karabo ke JSON, kapa stream ea server-sent events ha kopo e beha stream ho true. Endpoint e 'ngoe le e 'ngoe e araba ka sebopeho sa eona. Karabo e 'ngoe le e 'ngoe e na le header x-request-id.

Seo kopo e se fetang

Kopo e hlahlojoa ka tatellano e tsitsitseng pele model e sebetsa. Hlahlobo ea pele e hlolehang e a araba, kahoo 401 e ntse e sa u joetse letho ka body.

Sebopeho sa phoso

Phoso ke ntho ea JSON e nang le error e nang le type le message. /v1/messages e e koaletsa ka tsela eo li-SDK tsa Anthropic li e lebelletseng; tsela e 'ngoe le e 'ngoe e sebelisa sebopeho sa OpenAI.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}
  • Bala type le message. code le param li teng ho liphoso tse ling feela: li nke e le tse sa hlokahaleng. param kamehla ke null.
  • Ka mor'a hore stream e qale, boemo bo se bo le 200. Ho hloleha ho ntan ho fihla e le frame ea phoso ka hare ho stream.
  • Karabo e 'ngoe le e 'ngoe ea phoso e nka header x-request-id.
Boemo Mofuta Neng
400 invalid_request_error Body hase JSON e nepahetseng, id ea model ha e tsejoe, kapa model ha e amohele mofuta oa input oo u o rometseng.
401 authentication_error Senotlolo ha se eo kapa ha se nepahale.
404 not_found_error Tsela ha e eo.
405 api_error Tsela e teng, mokhoa ha o nepahale.
413 invalid_request_error Body e kholo ho feta 32 MiB.
415 invalid_request_error Content-Type hase application/json.
422 invalid_request_error Field e na le mofuta o fosahetseng oa JSON kapa field e hlokahalang ha e eo.
429 rate_limit_error Balance ha e koahele kopo, likopo tse fetang 120 li fihlile ka motsotso, likopo tsa Shannon Coder tsa fensetere li felile, kapa model e phathahane. Molaetsa o re ke efe.
5xx api_error Boemo ba 500, 502, 503 kapa 504: kopo e ne e nepahetse mme ha ea ka ea arajoa. E romele hape. 500 e ka nka mofuta server_error.

Diphoso

Billing le balance

  • Ho na le balance e le 'ngoe ka akhaonte, mme chat le API li e arolelana: allowance ea plan ea kajeno pele, ebe credit e rekiloeng. API ha e na quota ea eona.
  • Kopo e behela thoko output budget ea eona (max_tokens, default 4,096) mme ebe e lefisoa ka tokens tseo e li sebelisitseng ka 'nete, ka theko ea model.
  • Karabo e 'ngoe le e 'ngoe e tlaleha palo ea tokens ho usage. Leqephe la Keys & usage le bontša balance le seo kopo e 'ngoe le e 'ngoe e se jeleng.
  • Kopo e 'ngoe le e 'ngoe e sebeletsoa ka ho lekana. Moeli o le mong feela oa lebelo la likopo ke flood protection: likopo tse 120 ka motsotso ka akhaonte. Likopo tse romeloang ka parallel li ema moleng.

Meeli le balance Li-model le litheko Keys & usage

Li-field tse itšetlehileng ka model

Model e 'ngoe le e 'ngoe e amohela kopo e tšoanang. Li-field tse 'maloa li sebetsa ho li-model tse ling feela; tafole e re ke tse feng. Maqephe a li-endpoint a thathamisa field e 'ngoe le e 'ngoe.

Field Tlhaloso E sebelisoa ke
system Litaelo tsa model: molaetsa oa system ho Chat Completions, system ho Messages, instructions ho Responses. Li-model tse hosted tsa open-weight, shannon-1.6-*, shannon-2-*, shannon-coder-1
temperature Sampling temperature. Li-model tse hosted tsa open-weight, shannon-1.6-*, shannon-coder-1
top_p Nucleus sampling. Li-model tse hosted tsa open-weight
seed Seed e tsitsitseng bakeng sa sampling. Li-model tse hosted tsa open-weight
stop Ho fihlela ho li-stop sequence tse 4. Li-model tse hosted tsa open-weight
reasoning_effort Hore na model e nahana hakae pele e araba. reasoning.effort ho Responses, thinking ho Messages. Li-model tse hosted tsa open-weight
web_search true e lumella model hore e batle webeng bakeng sa kopo ena. Field ea API ena, ho Chat Completions le Messages. Li-model tsa Shannon ntle le shannon-coder-1
max_tokens Output budget. Ho model e 'ngoe le e 'ngoe e beha palo e behetsoeng thoko ho balance ea hau. E le moeli oa bolelele ba karabo: li-model tse hosted tsa open-weight, shannon-1.6-*, shannon-coder-1

Chat Completions

Ha u tsoa ho SDK ea OpenAI

  • Beha base URL ho https://api.shannon-ai.com/v1 le senotlolo ho senotlolo sa hau sa Shannon. Likopo tsa Chat Completions le Responses li ntan li sebetsa le SDK joalo ka ha e le.
  • model e tlameha ho ba id ea Shannon. Lebitso la model la provider e mong, le kang gpt-4o, le arajoa ka 400 le unknown model.
  • Reasoning e tla ka field ea eona: reasoning_content haufi le content, molaetsing le ho li-delta tsa stream.
  • Stream kamehla e nka usage chunk-ng ea eona ea ho qetela, hammoho le finish_reason.
  • Kopo ea tool ho stream e fihla e le chunk e le 'ngoe e nang le string e feletseng ea arguments.
  • Karabo e na le choice e le 'ngoe.
  • Litsela tsa OpenAI API tseo li seng tafoleng e ka holimo, tse kang /v1/embeddings, li arajoa ka 404.

Ha u tsoa ho SDK ea Anthropic

  • Beha base URL ho https://api.shannon-ai.com, ntle le /v1, le senotlolo ho senotlolo sa hau sa Shannon. SDK e se romela e le x-api-key.
  • model e tlameha ho ba id ea Shannon.
  • max_tokens ha e hlokahale ho API ena. Default ea eona ke 4,096.
  • Karabo e na le li-content block tsa mofuta thinking, text le tool_use. Block ea pele hase kamehla mongolo: khetha li-block ka type.
  • stop_reason ke end_turn kapa tool_use. Stream ea model ea Shannon e ka boela ea fela ka max_tokens.
  • anthropic-version le anthropic-beta lia amohelwa, kahoo SDK e sebetsa ntle le phetoho. Kopo ha e li hloke.
  • Liphoso ho /v1/messages li na le sebopeho sa Anthropic: {"type": "error", "error": {…}}.

Lisebelisoa tsa ho ngola code tse buang mebopeho ena li setupoa ka tsela e tšoanang: base URL, senotlolo, le id ea Shannon e le model. Lisebelisoa tsa CLI tsa ho ngola code