Trosolwg

Pwyntiau terfyn

Mae pob pwynt terfyn o dan un URL sylfaen ac fe'i gwasanaethir dros HTTPS.

https://api.shannon-ai.com

Mae'r tri phwynt terfyn sy'n cynhyrchu testun yn cyrraedd yr un modelau. Dewiswch yr un y mae ei fformat eisoes yn cael ei ddefnyddio gan eich cod.

Hanfodion ceisiadau

• Corff pob POST yw un gwrthrych JSON, hyd at 32 MiB.
• Nid yw maes nad yw'r API yn ei adnabod yn achosi gwall ac nid oes ganddo effaith. Nid yw cais a ysgrifennwyd ar gyfer darparwr arall yn methu oherwydd maes ychwanegol.
• Atebir maes hysbys gyda'r math JSON anghywir, neu faes gofynnol coll, â 422. Atebir corff nad yw'n JSON dilys â 400.
• Mae model yn un o'r ids ar Models & pricing. Nid yw priflythrennau a llythrennau bach o bwys.

Mae ateb yn JSON, neu'n ffrwd o ddigwyddiadau a anfonir gan y gweinydd pan fo'r cais yn gosod stream i true. Mae pob pwynt terfyn yn ateb yn ei fformat ei hun. Mae gan bob ateb y pennawd x-request-id.

Beth mae cais yn ei basio

Gwirir cais mewn trefn sefydlog cyn i fodel redeg. Mae'r gwiriad cyntaf sy'n methu yn ateb, felly nid yw 401 yn dweud dim eto am y corff.

Siâp gwall

Gwrthrych JSON yw gwall gydag error sy'n dal type a message. Mae /v1/messages yn ei lapio fel y mae SDKs Anthropic yn ei ddisgwyl; mae pob llwybr arall yn defnyddio'r siâp OpenAI.

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

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

• Darllenwch type a message. Mae code a param yn bresennol ar rai gwallau yn unig: trinnwch hwy fel rhai dewisol. Mae param bob amser yn null.
• Ar ôl i ffrwd ddechrau, mae'r statws eisoes yn 200. Mae methiant wedyn yn cyrraedd fel ffrâm gwall y tu mewn i'r ffrwd.
• Mae pob ateb gwall yn cario'r pennawd x-request-id.

Rheoli gwallau

Biliau a balans

• Mae un balans i bob cyfrif, ac mae sgwrs a'r API yn ei rannu: lwfans y cynllun heddiw yn gyntaf, yna credyd a brynwyd. Nid oes gan yr API gwota ei hun.
• Mae cais yn neilltuo ei gyllideb allbwn (max_tokens, rhagosodiad 4,096) ac yna codir tâl am y tokenau a ddefnyddiodd mewn gwirionedd, am bris y model.
• Mae pob ateb yn adrodd ei gyfrifon tokenau yn usage. Mae'r dudalen Keys & usage yn dangos y balans a beth gostiodd pob cais.
• Mae pob cais yn cael ei wasanaethu'n gyfartal. Yr unig derfyn ar gyfradd ceisiadau yw amddiffyniad rhag llifogydd: 120 cais y funud fesul cyfrif. Mae ceisiadau a anfonir yn gyfochrog yn aros yn y rhes.

Terfynau a balans Modelau a phrisiau Allweddi a defnydd

Meysydd sy'n dibynnu ar y model

Mae pob model yn cymryd yr un cais. Mae ychydig o feysydd yn dod i rym ar rai modelau yn unig; mae'r tabl yn enwi ble. Mae tudalennau'r pwyntiau terfyn yn rhestru pob maes.

Chat Completions

Os ydych yn dod o SDK OpenAI

• Gosodwch yr URL sylfaen i https://api.shannon-ai.com/v1 a'r allwedd i'ch allwedd Shannon. Mae galwadau Chat Completions a Responses wedyn yn gweithio gyda'r SDK fel y mae.
• Rhaid i model fod yn id Shannon. Atebir enw model darparwr arall, fel gpt-4o, â 400 ac unknown model.
• Daw rhesymu mewn maes ei hun: reasoning_content wrth ymyl content, yn y neges ac yn deltâu'r ffrwd.
• Mae ffrwd bob amser yn cario usage yn ei darn olaf, ynghyd â finish_reason.
• Mae galwad offeryn mewn ffrwd yn cyrraedd fel un darn gyda'r llinyn arguments cyflawn.
• Mae gan ateb un choice.
• Atebir llwybrau API OpenAI nad ydynt yn y tabl uchod, fel /v1/embeddings, â 404.

Os ydych yn dod o SDK Anthropic

• Gosodwch yr URL sylfaen i https://api.shannon-ai.com, heb /v1, a'r allwedd i'ch allwedd Shannon. Mae'r SDK yn ei hanfon fel x-api-key.
• Rhaid i model fod yn id Shannon.
• Mae max_tokens yn ddewisol ar yr API hwn. Ei ragosodiad yw 4,096.
• Mae ateb yn dal blociau cynnwys o'r math thinking, text a tool_use. Nid y bloc cyntaf yw'r testun bob amser: dewiswch flociau yn ôl type.
• Mae stop_reason yn end_turn neu tool_use. Gall ffrwd model Shannon hefyd ddod i ben gyda max_tokens.
• Derbynnir anthropic-version ac anthropic-beta, felly mae'r SDK yn gweithio heb newid. Nid oes eu hangen ar gais.
• Mae gan wallau ar /v1/messages y siâp Anthropic: {"type": "error", "error": {…}}.

Mae offer codio sy'n siarad y fformatau hyn yn cael eu gosod yn yr un ffordd: URL sylfaen, allwedd, ac id Shannon fel y model. Offer codio CLI