OpenAI Responses

Créez des réponses textuelles, avec images, appels d’outils et raisonnement via l’API compatible OpenAI Responses.

L’API Responses utilise des Typed Items pour représenter uniformément le texte, les images, les fichiers, les appels d’outils et les résultats de raisonnement. Elle convient aux applications nécessitant des entrées multimodales, des outils intégrés, des interactions avec état ou des événements sémantiques en streaming. Les types d’Item, outils et champs avancés disponibles varient selon le modèle ; fiez-vous aux modèles visibles pour le compte actuel et aux résultats réels des appels.

POST/v1/responses

Génère une réponse du modèle à partir de texte, d’images, de fichiers ou de Typed Input Items. L’API peut renvoyer différents Output Items, notamment des messages, des éléments de raisonnement et des appels d’outils, et transmet des événements sémantiques via SSE.

La prise en charge des images, outils intégrés, raisonnement, liens d’état et sorties structurées dépend des modèles visibles pour le compte actuel et de leur canal fournisseur. Commencez par une requête textuelle minimale, puis activez les champs avancés un par un.

Authentification

bearerAuth

AuthentificationBearer <token>

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

Emplacement: header

Corps de requête

Responses représente les entrées, outils et sorties avec des Typed Items. Choisissez une vue selon votre tâche ; l’application des champs dépend du modèle et du canal.

application/json

Entrée textuelle

Le plus simple est de passer une chaîne directement à input ; vous pouvez aussi utiliser des Typed Items sous forme de messages.

model: Identifiant d’un modèle visible pour votre clé API et compatible avec Responses.
input: Chaîne ou tableau de Typed Input Items.
instructions: Instructions de haut niveau applicables uniquement à cette réponse.

application/json

{
  "model": "MODEL_ID",
  "input": "Présentez-vous en trois phrases."
}

Réponse textuelle simple. input peut être une chaîne ou des Typed Input Items.

background?boolean|null

Indique si la réponse est exécutée en arrière-plan. La disponibilité dépend du modèle, du canal et des droits du compte.

Valeur par défautfalse

context_management?array<>|null

Configuration de gestion du contexte de la requête, par exemple une compression à partir d’un seuil de tokens.

conversation?string||null

Conversation à laquelle appartient cette réponse. Fournissez un identifiant de Conversation ou un objet contenant id ; incompatible avec previous_response_id.

model?string

Identifiant du modèle textuel Responses à utiliser. Choisissez un modèle visible pour votre clé API.

Longueur1 <= length

input?text input|array<||||||||||||||||||||||||||||||>

Entrée textuelle sous forme de chaîne, de messages ou d’autres Typed Items.

include?array<>|null

Données supplémentaires à joindre à la réponse.

instructions?string|array<||||||||||||||||||||||||||||||>|null

Message système ou développeur servant d’instructions de haut niveau pour cette réponse. Avec previous_response_id, les instructions de la réponse précédente ne sont pas automatiquement héritées.

max_output_tokens?integer|null

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

max_tool_calls?integer|null

Nombre total maximal d’appels d’outils intégrés pour cette réponse, et non une limite distincte pour chaque type d’outil.

Plage0 <= value

metadata?|null

Métadonnées clé-valeur jointes à l’objet de réponse. Clés de 64 caractères maximum et valeurs de 512 caractères maximum.

Champsproperties <= 16

parallel_tool_calls?boolean|null

Indique si le modèle peut exécuter des appels d’outils en parallèle.

Valeur par défauttrue

moderation?|null

Configuration de modération des entrées et des sorties de la réponse.

previous_response_id?string|null

Identifiant unique de la Response précédente pour poursuivre une interaction avec état. Incompatible avec conversation ; ses instructions ne sont pas automatiquement héritées.

prompt?|null

Référence à un modèle de Prompt enregistré et à ses variables.

prompt_cache_key?string|null

Améliore le taux de succès du cache de prompt pour les requêtes similaires et remplace l’usage de user pour le cache.

prompt_cache_options?|null

Configuration du cache de prompt au niveau de la requête. Les blocs de contenu peuvent définir des limites explicites avec prompt_cache_breakpoint.

prompt_cache_retention?string|null

Obsolète

Obsolète ; utilisez prompt_cache_options.ttl. Conservé pour la compatibilité avec l’ancienne stratégie de conservation du cache.

Valeurs autorisées

"in_memory"
"24h"
null

reasoning?|null

Configuration du modèle de raisonnement. Applicable uniquement aux modèles prenant en charge cette fonctionnalité.

service_tier?string|null

Niveau de service demandé. La valeur réelle de la réponse peut différer, par exemple priority pour une requête fast.

Valeur par défaut"auto"

Valeurs autorisées

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

safety_identifier?string|null

Identifiant stable d’utilisateur final pour la surveillance de sécurité et des abus. Hachez-le de préférence pour éviter de transmettre des données personnelles identifiables.

Longueurlength <= 64

store?boolean|null

Indique si la réponse générée est conservée. Le stockage, la lecture et la durée de conservation dépendent des capacités de la plateforme.

Valeur par défauttrue

stream?boolean|null

Si true, renvoie les événements sémantiques Responses via Server-Sent Events.

Valeur par défautfalse

stream_options?|null

Configuration du streaming, utilisée uniquement lorsque stream est true.

temperature?number|null

Température d’échantillonnage. En général, ne modifiez que temperature ou top_p.

Plage0 <= value <= 2

Valeur par défaut1

text?

tool_choice?||||||||

Détermine si le modèle sélectionne des outils et selon quelles modalités.

tools?array<|||||||||||||>

Outils intégrés ou fonctions personnalisées utilisables par le modèle. La prise en charge dépend du modèle et du canal.

top_logprobs?integer|null

Nombre de tokens candidats les plus probables renvoyés pour chaque position de sortie, de 0 à 20.

Plage0 <= value <= 20

top_p?number|null

Masse de probabilité de l’échantillonnage nucleus. En général, ne modifiez que top_p ou temperature.

Plage0 <= value <= 1

Valeur par défaut1

truncation?string|null

Obsolète

Stratégie de troncature lorsque le contexte dépasse la fenêtre. disabled fait échouer les requêtes dépassant la limite.

Valeur par défaut"disabled"

Valeurs autorisées

"auto"
"disabled"
null

user?string

Obsolète

Obsolète. Utilisez safety_identifier pour la sécurité et prompt_cache_key pour le regroupement du cache.

Les outils, l’état, le raisonnement et les capacités multimodales de Responses varient selon le modèle et le canal fournisseur. Commencez par une requête textuelle minimale, puis activez les champs avancés un par un.

Corps de réponse

`application/json`

curl -X POST "https://example.com/v1/responses" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "input": "Racontez en trois phrases une histoire de licorne pour s’endormir."  }'

{
  "id": "resp_example",
  "object": "response",
  "created_at": 1741476542,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "MODEL_ID",
  "output": [
    {
      "id": "msg_example",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "Sous la lune, une licorne découvre un sentier secret menant au ciel étoilé.",
          "annotations": []
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 18,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 22,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 40
  },
  "user": null,
  "metadata": {}
}

Documentation officielle OpenAI ResponsesConsultez 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`