Clé API Codex expliquée pour les développeurs

Comprendre le format de la clé API

Lors de l'inscription à un service fournissant une codex api key, vous recevez une chaîne alphanumérique unique. Cette clé sert d'identifiant d'authentification pour chaque requête envoyée au backend. Le format suit généralement un modèle standard, comme sk-..., selon l'implémentation du fournisseur. Cependant, avec un proxy indépendant, le préfixe exact peut varier. L'essentiel est de transmettre correctement la clé dans l'en-tête HTTP Authorization comme Bearer <your_key>.

Votre clé API est liée à un compte spécifique et à un niveau d'utilisation. Contrairement à certains services qui génèrent plusieurs clés pour différents environnements (dev vs prod), notre configuration est simple : un compte, une clé. Si vous perdez votre clé ou soupçonnez qu'elle a été compromise, vous pouvez la régénérer immédiatement depuis votre tableau de bord. Cela révoque instantanément l'ancienne clé, garantissant qu'aucun accès non autorisé ne persiste. N'oubliez pas de mettre à jour vos variables d'environnement ou vos fichiers de configuration chaque fois que vous faites tourner les clés.

Bonnes pratiques de sécurité

• Stockez votre clé dans des variables d'environnement, pas dans votre code source.
• Ne commettez jamais votre codex api key dans des dépôts publics.
• Utilisez la fonction de régénération si vous soupçonnez une exposition.

Erreur courante : 401 Non autorisé

Une erreur 401 Unauthorized est le problème le plus fréquent lors de l'intégration d'une nouvelle clé API. Elle indique que le serveur a rejeté vos identifiants d'authentification. Dans le contexte d'un claude code proxy ou de tout endpoint compatible OpenAI, cela signifie presque toujours que la clé est manquante, incorrecte ou expirée.

Pour résoudre le problème, vérifiez d'abord que vous copiez la clé exactement telle quelle. Les clés sont souvent sensibles à la casse et peuvent contenir des espaces si elles sont copiées incorrectement. Assurez-vous d'utiliser la bonne URL de base pour votre région ou votre niveau de service. Si vous avez récemment régénéré votre clé, assurez-vous que votre client utilise la nouvelle valeur. Une erreur 401 n'est pas liée à votre solde d'utilisation ou à vos limites de débit ; c'est purement un échec d'authentification.

Liste de contrôle pour la résolution

1. Confirmez que la chaîne de clé API correspond exactement au tableau de bord.
2. Vérifiez le format de l'en-tête Authorization : Authorization: Bearer YOUR_KEY.
3. Vérifiez que l'URL de base est correcte pour votre type de compte.
4. Assurez-vous qu'aucun espace blanc supplémentaire n'a été ajouté lors du copier-coller.

Limite de débit dépassée : erreurs 429

Lorsque vous dépassez votre volume de requêtes autorisé, l'API renvoie une erreur 429 Trop de requêtes. Pour notre service, la limite est fixée à 300 requêtes par minute par clé. Cette limite est appliquée pour garantir une utilisation équitable et maintenir une faible latence pour tous les utilisateurs. Si vous exécutez des sessions de codage à fort volume, vous pourriez atteindre cette limite rapidement, surtout si votre code déclenche plusieurs requêtes internes.

Lorsqu'une erreur 429 se produit, la réponse inclut généralement un en-tête Retry-After indiquant le nombre de secondes à attendre avant de réessayer. L'implémentation d'une rétroaction exponentielle dans le code de votre client est la méthode standard pour gérer ces erreurs avec élégance. Au lieu de réessérer immédiatement, attendez une courte période, puis doublez le temps d'attente pour les tentatives suivantes. Cela empêche votre application d'inonder le serveur de requêtes pendant que la limite se réinitialise.

Il est important de noter que les limites de débit sont par clé, et non par compte. Si vous avez plusieurs appareils ou processus utilisant la même clé, ils partagent le budget de 300 requêtes/minute. Envisagez d'utiliser des clés séparées pour différents environnements si vous avez besoin d'un débit agrégé plus élevé.

Configurer correctement l'URL de base

L'URL de base est le fondement de toute intégration API. Pour un service compatible OpenAI, l'URL de base détermine où vos requêtes sont envoyées. Notre URL de base est https://api.claudecodeapikey.com/v1. Cette URL doit être configurée dans votre bibliothèque cliente ou SDK avant de faire des requêtes. Si vous utilisez la mauvaise URL de base, vous recevrez des erreurs de connexion ou des réponses inattendues.

De nombreux développeurs utilisent le SDK officiel OpenAI pour Python, Node.js ou d'autres langages. Pour passer à notre proxy, vous devez simplement mettre à jour la configuration de l'URL de base. Par exemple, en Python, vous pourriez définir base_url='https://api.claudecodeapikey.com/v1'. Assurez-vous que le protocole (https) et le chemin (/v1) sont corrects. Omettre le chemin /v1 est une erreur courante qui entraîne des erreurs 404.

Vérifiez toujours que votre client envoie des requêtes au endpoint correct. Vous pouvez le faire en vérifiant vos journaux réseau ou en utilisant un outil comme curl pour tester la connexion. Une connexion réussie à l'URL de base confirme que votre configuration est correcte.

Gérer les réponses en streaming

Les réponses en streaming vous permettent de recevoir des parties de la réponse API au fur et à mesure de leur génération, au lieu d'attendre que toute la réponse soit terminée. Cela est crucial pour les agents de codage qui affichent des extraits de code en temps réel. Notre API prend en charge le streaming via les événements envoyés par le serveur (SSE). Lorsque vous activez le streaming dans votre client, vous recevrez un flux de chunks, chacun contenant une réponse partielle.

Pour activer le streaming, définissez le paramètre stream sur true dans votre requête. La bibliothèque cliente gérera alors automatiquement le protocole SSE. Vous pouvez traiter chaque chunk à son arrivée, en mettant à jour votre interface utilisateur ou en enregistrant la progression. Cela offre une meilleure expérience utilisateur, en particulier pour les longues générations de code.

Le streaming ne modifie pas le modèle sous-jacent ni ses capacités. C'est purement un mécanisme de transport. Le modèle traite toujours le prompt entier et génère la réponse complète ; la différence réside dans la manière dont la sortie est délivrée à votre client.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.claudecodeapikey.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Problèmes de configuration de l'appel d'outils

L'appel d'outils (ou appel de fonctions) permet au LLM de demander des actions spécifiques, telles que l'exécution d'un extrait de code ou l'interrogation d'une base de données. Notre API prend en charge l'appel d'outils, ce qui signifie que vous pouvez définir des fonctions dans votre requête et recevoir des réponses JSON structurées du modèle. C'est essentiel pour les agents de codage avancés qui doivent interagir avec des systèmes externes.

Pour configurer l'appel d'outils, vous devez fournir une liste de définitions de fonctions dans le paramètre tools. Chaque outil doit avoir un nom, une description et un schéma de paramètres. Le modèle décidera ensuite quand appeler un outil en fonction du prompt. Si le modèle décide d'appeler un outil, la réponse inclura un tableau tool_calls avec le nom de la fonction et les arguments.

Des problèmes courants surviennent en raison de définitions de schéma JSON incorrectes. Assurez-vous que les types de paramètres et les champs requis sont spécifiés avec précision. Si le schéma est invalide, le modèle peut échouer à appeler correctement l'outil. Testez vos définitions d'outils avec des prompts simples pour vérifier que le modèle comprend le comportement attendu.

Limites de la fenêtre de contexte

La fenêtre de contexte définit la quantité maximale de texte que le modèle peut traiter dans une seule requête, incluant à la fois le prompt (entrée) et la complétion (sortie). Notre modèle a une fenêtre de contexte de 100 000 tokens. C'est une quantité significative de texte, mais ce n'est pas infini. Si votre prompt plus la sortie attendue dépasse cette limite, l'API renverra une erreur.

Pour gérer le contexte efficacement, surveillez l'utilisation des tokens de vos prompts. Les fichiers longs ou les historiques de conversation étendus peuvent rapidement consommer les tokens disponibles. Si vous approchez de la limite, envisagez de tronquer les messages plus anciens ou de résumer les interactions précédentes. Certains clients gèrent cela automatiquement en faisant glisser la fenêtre, mais il est préférable d'être conscient de la limite pour éviter des erreurs inattendues.

N'oubliez pas que la fenêtre de contexte inclut tous les tokens envoyés au modèle, y compris les messages système, les messages utilisateur et les messages de l'assistant. Planifiez votre budget de tokens en conséquence pour garantir un fonctionnement fluide lors de longues sessions de codage.

Régénérer votre clé

La régénération de votre clé API est un processus simple qui garantit la sécurité. Si vous pensez que votre clé a été exposée ou si vous souhaitez faire tourner les identifiants périodiquement, vous pouvez en générer une nouvelle depuis votre tableau de bord. L'ancienne clé est immédiatement invalidée, donc toute requête en cours utilisant l'ancienne clé échouera.

Lorsque vous régénérez une clé, assurez-vous de mettre à jour tous vos clients et configurations avec la nouvelle valeur. Cela inclut les variables d'environnement, les fichiers de configuration et toute valeur codée en dur dans votre code. Le fait de ne pas mettre à jour tous les emplacements peut entraîner des erreurs d'authentification pour certaines parties de votre application.

Notre service permet un nombre illimité de régénérations de clé. Il n'y a aucune pénalité à faire tourner votre clé fréquemment. Il s'agit d'une bonne pratique pour maintenir la sécurité, en particulier dans les environnements partagés ou lors de la distribution des clés aux membres de l'équipe.

Copycurl https://api.claudecodeapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'