Référence API

Créer une réponse (OpenAI Responses API)

POST/v1/responses

Interface 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_KEY

Schémas d'authentification : BearerAuth

Requête

Corps de requête · application/json

Type
object
Champs obligatoires
modelinput

Corps de requête obligatoire

  • modelstringObligatoire
  • inputunionObligatoire

    Entrée, sous forme de chaîne ou tableau de messages

    Branche oneOf 1

    Type: string

    Branche oneOf 2

    Type: array

    • []objectFacultatif
  • instructionsstringFacultatif
  • max_output_tokensintegerFacultatif
  • temperaturenumberFacultatif

    Température d'échantillonnage. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • top_pnumberFacultatif

    Paramètre d'échantillonnage nucleus. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • streambooleanFacultatif
  • toolsarrayFacultatif
    Sous-champs de tools (1)
    • []objectFacultatif
  • tool_choiceunionFacultatif
    Branche oneOf 1

    Type: string

    Branche oneOf 2

    Type: object

  • reasoningobjectFacultatif
    Sous-champs de reasoning (2)
    • effortstringFacultatif
      Énumération
      ["low","medium","high"]
    • summarystringFacultatif
  • previous_response_idstringFacultatif
  • truncationstringFacultatif
    Énumération
    ["auto","disabled"]
  • parallel_tool_callsbooleanFacultatif

    Les appels d'outils parallèles dépendent du modèle choisi. Chat accepte un booléen ; Responses accepte les valeurs JSON du protocole compatible.

  • storebooleanFacultatif

    L'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_keystringFacultatif

    Identifiant 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_retentionunknownFacultatif

    Valeur 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_tierstringFacultatif

    Niveau 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.

  • textobjectFacultatif

    Configuration de sortie texte, dont format pour la sortie structurée ; prise en charge et limites selon le modèle.

    Sous-champs de text (1)
    • formatobjectFacultatif

      Format du texte et de la sortie structurée selon le modèle.

      Sous-champs de format (4)
      • typestringFacultatif

        Identifiants des formats de sortie pris en charge par le modèle.

      • namestringFacultatif

        Nom de la sortie structurée.

      • schemaobjectFacultatif

        JSON Schema pour la sortie structurée ; doit respecter les exigences du modèle.

        Propriétés supplémentaires
        true
      • strictbooleanFacultatif

        Exiger une sortie structurée stricte selon la prise en charge du modèle.

  • context_managementunknownFacultatif

    Gestion du contexte selon le modèle ; aucune garantie de résumé automatique ou de mémoire persistante.

  • stream_optionsobjectFacultatif

    Paramètres de flux Responses avec stream=true ; seuls les champs pris en charge sont appliqués.

    Sous-champs de stream_options (2)
    • include_usagebooleanFacultatif

      Demander l’usage en streaming ; disponibilité selon le modèle.

    • include_obfuscationbooleanFacultatif

      Contrô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

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

HTTP 403

Autorisations IP, compte, modèle ou outil insuffisantes.

application/json

Type
object
Champs obligatoires
error

HTTP 429

Limitation de débit des requêtes/de la file.

application/json

Type
object
Champs obligatoires
error

HTTP 500

Défaillance interne d'authentification ou de stockage des données.

application/json

Type
object
Champs obligatoires
error