Conspectus

Endpoints

Omne endpoint sub uno base URL est et per HTTPS servitur.

https://api.shannon-ai.com

Tria endpoints quae textum producunt ad eadem modelli perveniunt. Elige illud cuius formam codex tuus iam utitur.

Fundamenta petitionis

• Corpus omnis POST est unum objectum JSON, ad 32 MiB.
• Campus quem API non novit nullum errorem causat et nullum effectum habet. Petitio pro alio provisore scripta propter campum additum non deficit.
• Campus notus cum typo JSON falso, aut campus necessarius deest, respondetur cum 422. Corpus quod JSON validum non est respondetur cum 400.
• model est unum ex ids in Models & pricing. Litterae maiusculae et minusculae nihil referunt.

Responsio est JSON, aut stream server-sent events cum petitio stream ad true ponit. Quodque endpoint in sua forma respondet. Omnis responsio header x-request-id habet.

Quae petitio transit

Petitio certo ordine inspicitur antequam modellum currit. Prima inspectio quae deficit respondet, itaque 401 nihil adhuc de corpore dicit.

Forma erroris

Error est objectum JSON cum error quod type et message tenet. /v1/messages eum involvit ut SDK Anthropic exspectant; omnis alia via forma OpenAI utitur.

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

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

• Lege type et message. code et param in quibusdam erroribus tantum adsunt: tracta eos ut optionales. param semper est null.
• Postquam stream incepit, status iam est 200. Defectus tunc ut error frame intra stream advenit.
• Omnis responsio erroris header x-request-id fert.

Tractatio errorum

Factura et saldum

• Unum saldum est per rationem, et chat et API id communicant: primum quota plani diei, deinde creditum emptum. API quotam propriam non habet.
• Petitio budget outputi suum (max_tokens, defaultum 4,096) reservat et deinde pro tokens quos vere usa est computatur, ad pretium modelli.
• Omnis responsio numeros tokenum suos in usage nuntiat. Pagina Keys & usage saldum ostendit et quanti quaeque petitio constiterit.
• Omnis petitio aequaliter servitur. Solus limes celeritatis petitionum est defensio inundationis: 120 petitiones per minutum per rationem. Petitiones parallele missae in ordine exspectant.

Limites et saldum Modella et pretia Claves et usus

Campi qui a modello pendent

Omne modellum eandem petitionem accipit. Pauci campi in quibusdam modellis tantum valent; tabula ubi nominat. Paginae endpoints omnes campos enumerant.

Chat Completions

Si ex SDK OpenAI venis

• Pone base URL ad https://api.shannon-ai.com/v1 et clavem ad clavem tuam Shannon. Vocationes Chat Completions et Responses tunc cum SDK ut est operantur.
• model debet esse id Shannon. Nomen modelli alterius provisoris, ut gpt-4o, respondetur cum 400 et unknown model.
• Ratiocinatio in campo proprio venit: reasoning_content iuxta content, in nuntio et in deltas stream.
• Stream semper usage in ultimo chunk fert, una cum finish_reason.
• Vocatio tool in stream ut unum chunk cum toto string arguments advenit.
• Responsio unam choice habet.
• Viae API OpenAI quae in tabula supra non sunt, ut /v1/embeddings, respondentur cum 404.

Si ex SDK Anthropic venis

• Pone base URL ad https://api.shannon-ai.com, sine /v1, et clavem ad clavem tuam Shannon. SDK eam ut x-api-key mittit.
• model debet esse id Shannon.
• max_tokens in hac API optionalis est. Defaultum eius est 4,096.
• Responsio content blocks typorum thinking, text et tool_use tenet. Primus block non semper est textus: elige blocks per type.
• stop_reason est end_turn vel tool_use. Stream modelli Shannon etiam cum max_tokens finire potest.
• anthropic-version et anthropic-beta accipiuntur, itaque SDK sine mutatione operatur. Petitio eis non eget.
• Errores in /v1/messages formam Anthropic habent: {"type": "error", "error": {…}}.

Instrumenta codicis quae has formas loquuntur eodem modo parantur: base URL, clavis, et id Shannon ut modellum. Instrumenta CLI ad codicem scribendum