Aperçu

Endpoints

Chaque point de terminaison se trouve sous une seule URL de base et est servi en HTTPS.

https://api.shannon-ai.com

Les trois points de terminaison qui produisent du texte atteignent les mêmes modèles. Choisissez celui dont votre code utilise déjà le format.

Bases des requêtes

• Le corps de chaque POST est un objet JSON, jusqu'à 32 MiB.
• Un champ que l'API ne connaît pas ne cause aucune erreur et n'a aucun effet. Une requête écrite pour un autre fournisseur n'échoue pas à cause d'un champ supplémentaire.
• Un champ connu avec un mauvais type JSON, ou un champ obligatoire manquant, reçoit 422. Un corps qui n'est pas du JSON valide reçoit 400.
• model est l'un des ids de Modèles et tarifs. La casse n'a pas d'importance.

Une réponse est du JSON, ou un flux de server-sent events quand la requête définit stream à true. Chaque point de terminaison répond dans son propre format. Chaque réponse a l'en-tête x-request-id.

Ce par quoi passe une requête

Une requête est vérifiée dans un ordre fixe avant l'exécution d'un modèle. La première vérification qui échoue répond : un 401 ne vous dit donc encore rien sur le corps.

Forme des erreurs

Une erreur est un objet JSON avec un error qui contient type et message. /v1/messages l'encapsule comme l'attendent les SDK Anthropic ; tous les autres chemins utilisent la forme OpenAI.

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

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

• Lisez type et message. code et param ne sont présents que sur certaines erreurs : traitez-les comme facultatifs. param vaut toujours null.
• Une fois qu'un flux a démarré, le statut est déjà 200. Un échec arrive alors comme une trame d'erreur dans le flux.
• Chaque réponse d'erreur porte l'en-tête x-request-id.

Gestion des erreurs

Facturation et solde

• Il y a un solde par compte, et le chat et l'API le partagent : d'abord le forfait du jour, puis les crédits achetés. L'API n'a pas de quota propre.
• Une requête réserve son budget de sortie (max_tokens, 4,096 par défaut) puis est facturée pour les tokens réellement utilisés, au prix du modèle.
• Chaque réponse indique ses nombres de tokens dans usage. La page Clés et utilisation montre le solde et ce qu'a coûté chaque requête.
• Chaque requête est servie de façon égale. La seule limite sur le rythme des requêtes est la protection anti-flood : 120 requêtes par minute et par compte. Les requêtes envoyées en parallèle attendent en file.

Limites et solde Modèles et tarifs Clés et utilisation

Champs qui dépendent du modèle

Chaque modèle accepte la même requête. Quelques champs ne prennent effet que sur certains modèles ; le tableau indique lesquels. Les pages des points de terminaison listent chaque champ.

Chat Completions

Si vous venez d'un SDK OpenAI

• Définissez l'URL de base sur https://api.shannon-ai.com/v1 et la clé sur votre clé Shannon. Les appels Chat Completions et Responses fonctionnent alors avec le SDK tel quel.
• model doit être un id Shannon. Un nom de modèle d'un autre fournisseur, comme gpt-4o, reçoit 400 et unknown model.
• Le raisonnement arrive dans un champ à part : reasoning_content à côté de content, dans le message et dans les deltas du flux.
• Un flux porte toujours usage dans son dernier chunk, avec finish_reason.
• Un appel d'outil dans un flux arrive comme un seul chunk avec la chaîne arguments complète.
• Une réponse a un seul choix.
• Les chemins de l'API OpenAI qui ne figurent pas dans le tableau ci-dessus, comme /v1/embeddings, reçoivent 404.

Si vous venez d'un SDK Anthropic

• Définissez l'URL de base sur https://api.shannon-ai.com, sans /v1, et la clé sur votre clé Shannon. Le SDK l'envoie comme x-api-key.
• model doit être un id Shannon.
• max_tokens est facultatif sur cette API. Sa valeur par défaut est 4,096.
• Une réponse contient des blocs de contenu de type thinking, text et tool_use. Le premier bloc n'est pas toujours le texte : choisissez les blocs par type.
• stop_reason vaut end_turn ou tool_use. Un flux d'un modèle Shannon peut aussi se terminer par max_tokens.
• anthropic-version et anthropic-beta sont acceptés, de sorte que le SDK fonctionne sans changement. Une requête n'en a pas besoin.
• Les erreurs sur /v1/messages ont la forme Anthropic : {"type": "error", "error": {…}}.

Les outils de programmation qui parlent ces formats se configurent de la même façon : URL de base, clé, et un id Shannon comme modèle. Outils CLI de programmation