Compatibilité avec le SDK OpenAI

Premiers pas avec le SDK OpenAI

Pour utiliser la fonctionnalité de compatibilité avec le SDK OpenAI, vous devez :

1. Utiliser un SDK OpenAI officiel
2. Modifier les éléments suivants
   • Mettre à jour votre URL de base pour qu'elle pointe vers la Claude API
   • Remplacer votre clé API par une clé API Claude provenant de la Claude Console
   • Si votre clé est une clé personnelle ou de compte de service ayant accès à plusieurs espaces de travail, envoyer également l'en-tête anthropic-workspace-id à chaque requête (par exemple, default_headers dans le SDK Python ou defaultHeaders en TypeScript) ; consultez Sélectionner un espace de travail
   • Mettre à jour le nom de votre modèle pour utiliser un modèle Claude
3. Consulter les sections suivantes pour connaître les fonctionnalités prises en charge

Exemple de démarrage rapide

import os

from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("ANTHROPIC_API_KEY"),  # Your Claude API key
    base_url="https://api.anthropic.com/v1/",  # the Claude API endpoint
)

response = client.chat.completions.create(
    model="claude-opus-5-5",  # Claude model name
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Who are you?"},
    ],
)

print(response.choices[0].message.content)

Limitations importantes de la compatibilité OpenAI

Comportement de l'API

Voici les différences les plus importantes par rapport à l'utilisation d'OpenAI :

• Le paramètre strict pour l'appel de fonctions est ignoré, ce qui signifie que le JSON d'utilisation d'outils n'est pas garanti de respecter le schéma fourni. Pour une conformité garantie au schéma, utilisez la Claude API native avec les sorties structurées.
• L'entrée audio n'est pas prise en charge ; elle sera ignorée et supprimée de l'entrée.
• La « prompt caching » (mise en cache des prompts) n'est pas prise en charge, mais elle l'est dans les SDK Anthropic.
• Les messages système/développeur sont remontés et concaténés dans le champ system de premier niveau, quel que soit leur emplacement dans la conversation. Pour ajouter des instructions système en cours de conversation, utilisez les messages système en cours de conversation dans la Claude API native.

La plupart des champs non pris en charge sont ignorés silencieusement plutôt que de produire des erreurs. Ils sont tous documentés dans les sections suivantes.

Considérations sur la qualité des sorties

Si vous avez considérablement ajusté votre prompt, il est probablement bien adapté spécifiquement à OpenAI. Envisagez de le retravailler pour Claude à l'aide du guide des bonnes pratiques de prompting.

Remontée des messages système / développeur

La plupart des entrées du SDK OpenAI correspondent clairement et directement aux paramètres de l'API Claude, mais une différence notable concerne le traitement des prompts système / développeur. Ces deux types de prompts peuvent être placés tout au long d'une conversation dans l'API OpenAI. La couche de compatibilité prend tous les messages système/développeur et les concatène avec un seul saut de ligne (\n) entre eux. Cette chaîne complète est ensuite fournie comme champ system de niveau supérieur, avant tous les messages.

Prise en charge de la réflexion

Vous pouvez activer la réflexion en ajoutant le paramètre thinking. Sur les modèles actuels, la réflexion est adaptative, Claude déterminant quand et avec quelle profondeur réfléchir, et sur les modèles Claude 5, elle est activée par défaut ; la réflexion étendue configurée manuellement est un mode hérité. Bien que la réflexion améliore le raisonnement de Claude pour les tâches complexes, le SDK OpenAI ne renvoie pas la réflexion de Claude. Pour bénéficier de toutes les fonctionnalités de réflexion, y compris la réflexion résumée, utilisez la Claude API native.

response = client.chat.completions.create(
    model="claude-sonnet-4-6",
    messages=[{"role": "user", "content": "Who are you?"}],
    extra_body={"thinking": {"type": "enabled", "budget_tokens": 2000}},
)

Limites de débit

Les « rate limits » (limites de débit) suivent les limites standard d'Anthropic pour le point de terminaison /v1/messages.

Prise en charge détaillée de l'API compatible OpenAI

Champs de requête

Champs simples

Champs tools / functions

Champs du tableau messages

Champs de réponse

Compatibilité des messages d'erreur

La couche de compatibilité maintient des formats d'erreur cohérents avec l'API OpenAI. Cependant, les messages d'erreur détaillés ne sont pas équivalents. N'utilisez les messages d'erreur que pour la journalisation et le débogage.

Compatibilité des en-têtes

Bien que le SDK OpenAI gère automatiquement les en-têtes, voici la liste complète des en-têtes pris en charge par l'API Claude pour les développeurs qui doivent les manipuler directement.