Chat Completions

Créez des réponses textuelles, multimodales et avec appels d’outils via l’API Chat Completions compatible OpenAI.

L’API Chat Completions génère une réponse à partir d’une liste de messages. Elle convient aux conversations textuelles, aux entrées multimodales, au streaming, aux sorties structurées et aux appels d’outils de fonction. Les types d’entrée et paramètres avancés disponibles varient selon le modèle ; vérifiez les modèles accessibles avec votre clé API actuelle et les résultats réels des appels.

POST/v1/chat/completions

Génère une réponse du modèle à partir de la liste de messages fournie. L’API prend en charge les réponses ordinaires et le streaming SSE ; les fonctionnalités avancées, telles que les images, l’audio, les appels d’outils et les sorties structurées, dépendent du modèle choisi.

Lorsque vous changez de modèle, vérifiez d’abord ses capacités de base avec une requête textuelle minimale, puis activez les paramètres avancés un par un.

Authentification

bearerAuth

AuthentificationBearer <token>

Utilisez Bearer your-api-key dans le Header Authorization.

Emplacement: header

Corps de requête

Choisissez la structure de requête selon la modalité d’entrée du modèle. Les trois vues utilisent le même endpoint Chat Completions et les mêmes paramètres de génération communs.

application/json

Conversation textuelle

Utilisez ce mode pour la conversation, la génération de contenu et le raisonnement textuel. Le contenu du message peut être une chaîne de caractères.

model: Identifiant d’un modèle de texte disponible pour le compte actuel.
messages[].role: Rôle du message, par exemple user, system ou assistant.
messages[].content: Message textuel sous forme de chaîne de caractères.

application/json

{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "user",
      "content": "Bonjour ! Présentez-vous en une phrase."
    }
  ]
}

Requête de conversation textuelle. Les messages utilisateur peuvent être des chaînes ou des tableaux de contenu contenant uniquement du texte.

model*string

Identifiant du modèle de texte à utiliser. Copiez depuis le catalogue un identifiant visible pour le compte actuel et prenant en charge l’entrée textuelle.

Longueur1 <= length

messages*array<|||||>

Messages de conversation textuelle dans leur ordre d’envoi.

Éléments1 <= items

store?boolean|null

Indique si la sortie de cette complétion doit être conservée. L’application dépend du modèle et du canal choisis.

Valeur par défautfalse

reasoning_effort?string|null

Effort de raisonnement du modèle. Les valeurs disponibles dépendent du modèle ; none désactive explicitement l’effort de raisonnement.

Valeur par défaut"medium"

Valeurs autorisées

"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
"max"
null

metadata?|null

Métadonnées clé-valeur jointes à la requête. Clés de 64 caractères maximum et valeurs de 512 caractères maximum.

Champsproperties <= 16

modalities?array<>|null

Types de sortie souhaités. Par défaut, seul du texte est généré.

prediction?|null

Configuration de contenu prédit lorsque la majeure partie de la sortie attendue est connue.

audio?|null

Configuration du format et de la voix pour une sortie audio.

temperature?number|null

Température d’échantillonnage. En général, ne modifiez que temperature ou top_p ; la prise en charge dépend du modèle.

Plage0 <= value <= 2

Valeur par défaut1

top_p?number|null

Masse de probabilité de l’échantillonnage nucleus. En général, ne modifiez que temperature ou top_p ; la prise en charge dépend du modèle.

Plage0 <= value <= 1

Valeur par défaut1

n?integer|null

Nombre de réponses candidates générées pour chaque entrée. Plusieurs candidates augmentent l’utilisation.

Plage1 <= value <= 128

Valeur par défaut1

stop?string|array<string>|null

Jusqu’à quatre séquences d’arrêt. La prise en charge et le comportement dépendent du modèle.

max_tokens?integer|null

Obsolète

Ancien paramètre de limite de tokens de sortie. Utilisez de préférence max_completion_tokens.

Plage1 <= value

max_completion_tokens?integer|null

Limite de tokens générés pour la complétion, incluant la sortie visible et les tokens de raisonnement.

presence_penalty?number|null

Pénalité fondée sur la présence antérieure d’un token pour favoriser de nouveaux sujets. La prise en charge dépend du modèle.

Plage-2 <= value <= 2

Valeur par défaut0

frequency_penalty?number|null

Pénalité fondée sur la fréquence d’apparition d’un token pour réduire les répétitions. La prise en charge dépend du modèle.

Plage-2 <= value <= 2

Valeur par défaut0

logit_bias?|null

Associe des identifiants de tokens à des valeurs de biais comprises entre -100 et 100.

logprobs?boolean|null

Indique si les probabilités logarithmiques des tokens de sortie sont renvoyées. La prise en charge dépend du modèle.

Valeur par défautfalse

user?string

Obsolète

Identifiant d’utilisateur final obsolète. Utilisez safety_identifier pour la surveillance de sécurité et prompt_cache_key pour le routage du cache.

safety_identifier?string|null

Identifiant stable d’utilisateur final pour la surveillance de sécurité et des abus. Fournissez de préférence une valeur hachée sans données personnelles.

Longueurlength <= 64

prompt_cache_key?string|null

Clé stable améliorant le taux de succès du cache pour des requêtes similaires. N’incluez aucune donnée personnelle ou sensible.

prompt_cache_options?|null

Configuration du cache de prompt au niveau de la requête.

prompt_cache_retention?string|null

Obsolète

Configuration obsolète de conservation du cache. Utilisez prompt_cache_options.ttl.

Valeurs autorisées

"in_memory"
"24h"
null

verbosity?string|null

Niveau de détail des réponses textuelles. La prise en charge dépend du modèle.

Valeur par défaut"medium"

Valeurs autorisées

"low"
"medium"
"high"
null

moderation?|null

Configure les stratégies de modération des entrées et des sorties.

service_tier?string|null

Niveau de service demandé. Sa disponibilité dépend du compte et des capacités du fournisseur.

Valeur par défaut"auto"

Valeurs autorisées

"auto"
"default"
"flex"
"scale"
"priority"
"fast"
null

stream_options?|null

Options de streaming utilisées uniquement avec stream: true.

response_format?||

Format de sortie du modèle. La prise en charge des sorties structurées dépend du modèle.

seed?integer|null

Obsolète

Paramètre bêta visant un échantillonnage déterministe, sans garantie de déterminisme complet.

tools?array<|>

Liste des outils que le modèle peut appeler.

Élémentsitems <= 128

functions?array<>

Obsolète

Anciennes définitions de fonctions. Utilisez de préférence tools.

tool_choice?|||

Détermine si le modèle appelle des outils, impose un outil précis ou limite les outils disponibles à une liste.

function_call?|

Obsolète

Ancien paramètre de sélection de fonction. Utilisez de préférence tool_choice.

parallel_tool_calls?boolean

Indique si le modèle peut appeler plusieurs outils en parallèle dans une réponse.

Valeur par défauttrue

stream?boolean|null

Si true, renvoie progressivement les blocs de complétion via Server-Sent Events.

Valeur par défautfalse

top_logprobs?integer|null

Nombre de tokens les plus probables renvoyés pour chaque position. Définissez également logprobs: true ; la prise en charge dépend du modèle.

Plage0 <= value <= 20

web_search_options?

Les entrées image et audio nécessitent un modèle prenant en charge la modalité correspondante. Vérifiez les modèles disponibles pour le compte actuel et les capacités réelles de l’API.

Corps de réponse

`application/json`

curl -X POST "https://example.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "messages": [      {        "role": "user",        "content": "Bonjour ! Présentez-vous en une phrase."      }    ]  }'

{
  "id": "chatcmpl_example",
  "object": "chat.completion",
  "created": 1741569952,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Bonjour ! Comment puis-je vous aider ?",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 19,
    "completion_tokens": 10,
    "total_tokens": 29,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}

Documentation officielle OpenAI Chat CompletionsConsultez la définition du protocole du fournisseur et les dernières modifications des champs.

Authentification

Corps de requête

Corps de réponse

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`