Référence API
Créer une réponse (OpenAI Responses API)
/v1/responsesInterface Responses pour texte et appels d’outils ; champs facultatifs et types d’outils selon le modèle. stream=true renvoie des événements SSE typés ; previous_response_id ne garantit ni stockage persistant ni récupération.
Authentification et autorisations
Utilisez votre clé GloopAPI actuelle. Les modèles, capacités et autorisations disponibles dépendent de son catalogue et de la documentation du point de terminaison.
Authorization: Bearer $GLOOP_API_KEYSchémas d'authentification : BearerAuth
Requête
Corps de requête · application/json
- Type
- object
- Champs obligatoires
modelinput
Corps de requête obligatoire
modelstringObligatoireinputunionObligatoireEntrée, sous forme de chaîne ou tableau de messages
Branche oneOf 1
Type: string
instructionsstringFacultatifmax_output_tokensintegerFacultatiftemperaturenumberFacultatifTempérature d'échantillonnage. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
top_pnumberFacultatifParamètre d'échantillonnage nucleus. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
streambooleanFacultatiftoolsarrayFacultatifSous-champs de tools (1)
[]objectFacultatif
tool_choiceunionFacultatifBranche oneOf 1
Type: string
Branche oneOf 2
Type: object
reasoningobjectFacultatifprevious_response_idstringFacultatiftruncationstringFacultatif- Énumération
["auto","disabled"]
parallel_tool_callsbooleanFacultatifLes appels d'outils parallèles dépendent du modèle choisi. Chat accepte un booléen ; Responses accepte les valeurs JSON du protocole compatible.
storebooleanFacultatifL'autorisation de conserver les requêtes et réponses dépend du modèle choisi et des capacités du service. Ce paramètre ne fournit pas une API générale de stockage des conversations.
prompt_cache_keystringFacultatifIdentifiant d'association du cache de prompts service, selon modèle, sans garantie de prise en charge ou de succès. Chat accepte une chaîne ; Responses une valeur JSON du protocole service.
prompt_cache_retentionunknownFacultatifValeur JSON de contrôle de conservation du cache de prompts service, selon modèle. La plateforme ne garantit ni énumération, ni valeur par défaut, ni durée uniforme.
service_tierstringFacultatifNiveau de service demandé, pouvant modifier le coût. Ignoré par défaut et appliqué uniquement s'il est pris en charge. Les valeurs acceptées dépendent du modèle choisi.
textobjectFacultatifConfiguration de sortie texte, dont format pour la sortie structurée ; prise en charge et limites selon le modèle.
Sous-champs de text (1)
formatobjectFacultatifFormat du texte et de la sortie structurée selon le modèle.
Sous-champs de format (4)
typestringFacultatifIdentifiants des formats de sortie pris en charge par le modèle.
namestringFacultatifNom de la sortie structurée.
schemaobjectFacultatifJSON Schema pour la sortie structurée ; doit respecter les exigences du modèle.
- Propriétés supplémentaires
true
strictbooleanFacultatifExiger une sortie structurée stricte selon la prise en charge du modèle.
context_managementunknownFacultatifGestion du contexte selon le modèle ; aucune garantie de résumé automatique ou de mémoire persistante.
stream_optionsobjectFacultatifParamètres de flux Responses avec stream=true ; seuls les champs pris en charge sont appliqués.
Sous-champs de stream_options (2)
include_usagebooleanFacultatifDemander l’usage en streaming ; disponibilité selon le modèle.
include_obfuscationbooleanFacultatifContrôle d’obfuscation du flux Responses ; ignoré par défaut, effectif uniquement si pris en charge.
Réponses et erreurs
HTTP 200
Réponse créée
application/json
- Type
- object
- Propriétés supplémentaires
- false
idstringFacultatifobjectstringFacultatifcreated_atintegerFacultatifstatusstringFacultatif- Énumération
["completed","failed","in_progress","incomplete"]
modelstringFacultatifoutputarrayFacultatifSous-champs de output (1)
[]objectFacultatif- Propriétés supplémentaires
false
Sous-champs de [] (8)
typestringFacultatifidstringFacultatifstatusstringFacultatifrolestringFacultatifcontentarrayFacultatifSous-champs de content (1)
[]objectFacultatif- Propriétés supplémentaires
false
Sous-champs de [] (3)
typestringFacultatif- Énumération
["output_text","refusal"]
textstringFacultatifannotationsarrayFacultatifSous-champs de annotations (1)
[]objectFacultatif
call_idstringFacultatifnamestringFacultatifargumentsstringFacultatif
usageobjectFacultatifSous-champs de usage (5)
prompt_tokensintegerFacultatifNombre de tokens du prompt
completion_tokensintegerFacultatifNombre de tokens de complétion
total_tokensintegerFacultatifNombre total de tokens
prompt_tokens_detailsobjectFacultatifSous-champs de prompt_tokens_details (4)
cached_tokensintegerFacultatiftext_tokensintegerFacultatifaudio_tokensintegerFacultatifimage_tokensintegerFacultatif
completion_tokens_detailsobjectFacultatifSous-champs de completion_tokens_details (3)
text_tokensintegerFacultatifaudio_tokensintegerFacultatifreasoning_tokensintegerFacultatif
text/event-stream
- Type
- string
- Description
- Flux SSE ; événements, utilisation et terminaison suivent l'interface actuelle. Des erreurs peuvent apparaître dans le flux.
{
"type": "string",
"description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}HTTP 401
Key absente, invalide, expirée ou révoquée.
application/json
- Type
- object
- Champs obligatoires
error
errorobjectObligatoireSous-champs de error (4)
codestringFacultatifmessagestringFacultatiftypestringFacultatifrequest_idstringFacultatif
HTTP 403
Autorisations IP, compte, modèle ou outil insuffisantes.
application/json
- Type
- object
- Champs obligatoires
error
errorobjectObligatoireSous-champs de error (4)
codestringFacultatifmessagestringFacultatiftypestringFacultatifrequest_idstringFacultatif
HTTP 429
Limitation de débit des requêtes/de la file.
application/json
- Type
- object
- Champs obligatoires
error
errorobjectObligatoireSous-champs de error (4)
codestringFacultatifmessagestringFacultatiftypestringFacultatifrequest_idstringFacultatif
HTTP 500
Défaillance interne d'authentification ou de stockage des données.
application/json
- Type
- object
- Champs obligatoires
error
errorobjectObligatoireSous-champs de error (4)
codestringFacultatifmessagestringFacultatiftypestringFacultatifrequest_idstringFacultatif