Përmbledhje

Endpoint-et

Çdo endpoint ndodhet nën një URL bazë dhe shërbehet përmes HTTPS.

https://api.shannon-ai.com

Të tri endpoint-et që prodhojnë tekst arrijnë të njëjtat modele. Zgjidhni atë, formatin e të cilit e përdor tashmë kodi juaj.

Bazat e kërkesës

• Trupi i çdo POST është një objekt JSON, deri në 32 MiB.
• Një fushë që API-ja nuk e njeh nuk shkakton gabim dhe nuk ka efekt. Një kërkesë e shkruar për një ofrues tjetër nuk dështon për shkak të një fushe shtesë.
• Një fushë e njohur me lloj JSON të gabuar, ose një fushë e detyrueshme që mungon, merr përgjigje 422. Një trup që nuk është JSON i vlefshëm merr përgjigje 400.
• model është një nga id-të te Modelet dhe çmimet. Shkronjat e mëdha dhe të vogla nuk kanë rëndësi.

Një përgjigje është JSON, ose një stream server-sent events kur kërkesa vendos stream në true. Çdo endpoint përgjigjet në formatin e vet. Çdo përgjigje ka header-in x-request-id.

Çfarë kalon një kërkesë

Një kërkesë kontrollohet në një radhë të fiksuar para se të ekzekutohet një model. Kontrolli i parë që dështon përgjigjet, kështu që një 401 ende nuk ju tregon asgjë për trupin.

Forma e gabimit

Një gabim është një objekt JSON me një error që mban type dhe message. /v1/messages e mbështjell ashtu siç e presin SDK-të Anthropic; çdo rrugë tjetër përdor formën OpenAI.

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

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

• Lexoni type dhe message. code dhe param janë të pranishme vetëm te disa gabime: trajtojini si opsionale. param është gjithmonë null.
• Pasi një stream ka nisur, statusi është tashmë 200. Një dështim pastaj arrin si frame gabimi brenda stream-it.
• Çdo përgjigje gabimi mban header-in x-request-id.

Trajtimi i gabimeve

Faturimi dhe bilanci

• Ka një bilanc për llogari, dhe biseda e API e ndajnë: fillimisht kuota e planit për sot, pastaj krediti i blerë. API-ja nuk ka kuotë të vetën.
• Një kërkesë rezervon buxhetin e saj të daljes (max_tokens, parazgjedhja 4,096) dhe pastaj faturohet për tokens-at që përdori realisht, me çmimin e modelit.
• Çdo përgjigje i raporton numërimet e saj të tokens-ave te usage. Faqja Çelësat dhe përdorimi tregon bilancin dhe çfarë kushtoi çdo kërkesë.
• Çdo kërkesë shërbehet njësoj. I vetmi kufi për shpejtësinë e kërkesave është mbrojtja nga vërshimi i kërkesave: 120 kërkesa në minutë për llogari. Kërkesat e dërguara paralelisht presin në radhë.

Kufijtë dhe bilanci Modelet dhe çmimet Çelësat dhe përdorimi

Fusha që varen nga modeli

Çdo model pranon të njëjtën kërkesë. Disa fusha vlejnë vetëm te disa modele; tabela tregon ku. Faqet e endpoint-eve listojnë çdo fushë.

Chat Completions

Nëse vini nga një SDK OpenAI

• Caktoni URL-në bazë në https://api.shannon-ai.com/v1 dhe çelësin në çelësin tuaj Shannon. Thirrjet Chat Completions dhe Responses pastaj funksionojnë me SDK-në siç është.
• model duhet të jetë një id Shannon. Një emër modeli i një ofruesi tjetër, si gpt-4o, merr përgjigje 400 dhe unknown model.
• Arsyetimi vjen në një fushë më vete: reasoning_content pranë content, në mesazh dhe në delta-t e stream-it.
• Një stream mban gjithmonë usage në pjesën e fundit, së bashku me finish_reason.
• Një thirrje mjeti në një stream arrin si një pjesë e vetme me stringun e plotë arguments.
• Një përgjigje ka një choice.
• Rrugët e API-t OpenAI që nuk janë në tabelën më sipër, si /v1/embeddings, marrin përgjigje 404.

Nëse vini nga një SDK Anthropic

• Caktoni URL-në bazë në https://api.shannon-ai.com, pa /v1, dhe çelësin në çelësin tuaj Shannon. SDK-ja e dërgon si x-api-key.
• model duhet të jetë një id Shannon.
• max_tokens është opsional në këtë API. Parazgjedhja e tij është 4,096.
• Një përgjigje mban blloqe përmbajtjeje të llojit thinking, text dhe tool_use. Blloku i parë nuk është gjithmonë teksti: zgjidhini blloqet sipas type.
• stop_reason është end_turn ose tool_use. Një stream i një modeli Shannon mund të mbarojë edhe me max_tokens.
• anthropic-version dhe anthropic-beta pranohen, kështu që SDK-ja funksionon pa ndryshime. Një kërkesë nuk ka nevojë për to.
• Gabimet në /v1/messages kanë formën Anthropic: {"type": "error", "error": {…}}.

Mjetet e kodimit që flasin këto formate konfigurohen njësoj: URL bazë, çelës dhe një id Shannon si model. Mjete CLI për kodim