Pfupiso

Endpoints

Endpoint imwe neimwe iri pasi pe-base URL imwe uye inoshandirwa kuburikidza ne-HTTPS.

https://api.shannon-ai.com

Ma-endpoint matatu anogadzira text anosvika kuma-model akafanana. Sarudza iro rine format yatoshandiswa ne-code yako.

Zvekutanga ze-request

• Body ye-POST imwe neimwe i-JSON object imwe, kusvika ku-32 MiB.
• Field isingazikanwi ne-API haiunze error uye haina mhedzisiro. Request yakanyorerwa provider imwe haikundikane nekuda kwe-field yakawedzerwa.
• Field inozikanwa ine JSON type isiriyo, kana field inodiwa isipo, inopindurwa ne-422. Body isiri JSON chaiyo inopindurwa ne-400.
• model imwe yema-id ari pa-Models & pricing. Mavara makuru nemadiki haana basa.

Mhinduro i-JSON, kana stream ye-server-sent events kana request ichiisa stream ku-true. Endpoint imwe neimwe inopindura mu-format yayo. Mhinduro imwe neimwe ine header x-request-id.

Zvinopfuurwa ne-request

Request inotariswa nenhevedzano yakatarwa model isati yamhanya. Check yekutanga inokundikana ndiyo inopindura, saka 401 haikuudze chinhu nezve body.

Chimiro che-error

Error i-JSON object ine error ine type ne-message. /v1/messages inoipfekedza sezvinotarisirwa ne-Anthropic SDKs; path imwe neimwe inoshandisa OpenAI shape.

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

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

• Verenga type ne-message. code ne-param dziripo pane mamwe ma-error chete: dzitore sedzisingadiwi. param inogara iri null.
• Stream yatotanga, status yatova 200. Kundikana kunobva kwauya se-error frame mukati me-stream.
• Error reply imwe neimwe inotakura header x-request-id.

Zvikanganiso

Billing ne-balance

• Kune balance imwe pa-account imwe, uye chat ne-API zvinoigovana: plan allowance yanhasi kutanga, wozoshandisa purchased credit. API haina quota yayo.
• Request inochengeta output budget yayo (max_tokens, default 4,096) uye inobva yabhadharwa tokens dzayakashandisa chaizvo, pamutengo we-model.
• Mhinduro imwe neimwe inoratidza huwandu hwe-tokens mu-usage. Peji reKeys & usage rinoratidza balance nezvakadhura request imwe neimwe.
• Request imwe neimwe inoshandirwa zvakaenzana. Limit imwe chete ye-request rate i-flood protection: ma-request 120 paminiti imwe pa-account imwe. Ma-request anotumirwa parallel anomirira pamutsara.

Limits ne-balance Ma-model nemitengo Keys & usage

Ma-field anoenderana ne-model

Model imwe neimwe inotora request imwechete. Ma-field mashoma anoshanda pane mamwe ma-model chete; tafura inoti kupi. Mapeji e-endpoint anoratidza field imwe neimwe.

Chat Completions

Kana uchibva ku-OpenAI SDK

• Isa base URL ku-https://api.shannon-ai.com/v1 uye key ku-Shannon key yako. Chat Completions ne-Responses calls dzinobva dzashanda ne-SDK sezvayakaita.
• model inofanira kuva Shannon id. Zita re-model ye-provider imwe, sa-gpt-4o, rinopindurwa ne-400 ne-unknown model.
• Reasoning inouya mu-field yayo pachayo: reasoning_content padivi pe-content, mu-message nemu-stream deltas.
• Stream inogara ichitakura usage mu-chunk yayo yekupedzisira, pamwe chete ne-finish_reason.
• Tool call mu-stream inouya se-chunk imwe ine arguments string yakazara.
• Mhinduro ine choice imwe.
• Paths dze-OpenAI API dziri kunze kwetafura iri pamusoro, sa-/v1/embeddings, dzinopindurwa ne-404.

Kana uchibva ku-Anthropic SDK

• Isa base URL ku-https://api.shannon-ai.com, isina /v1, uye key ku-Shannon key yako. SDK inoitumira se-x-api-key.
• model inofanira kuva Shannon id.
• max_tokens haidiwi pa-API iyi. Default yayo i-4,096.
• Mhinduro ine content blocks dze-type thinking, text ne-tool_use. Block yekutanga haisi nguva dzese text: sarudza ma-block ne-type.
• stop_reason i-end_turn kana tool_use. Stream ye-Shannon model inogona kupera ne-max_tokens.
• anthropic-version ne-anthropic-beta dzinogamuchirwa, saka SDK inoshanda isina kuchinjwa. Request haizvidi.
• Errors pa-/v1/messages dzine Anthropic shape: {"type": "error", "error": {…}}.

Coding tools dzinotaura ma-format aya dzinogadzirwa nenzira imwechete: base URL, key, ne-Shannon id se-model. CLI tools dzekunyora code