Referencia de API

Crear una respuesta (OpenAI Responses API)

POST/v1/responses

Interfaz Responses de texto y llamadas a herramientas; los campos opcionales y tipos de herramientas dependen del modelo. stream=true devuelve eventos SSE tipados; previous_response_id no garantiza almacenamiento persistente ni recuperación.

Autenticación y permisos

Usa tu clave actual de GloopAPI. Los modelos, capacidades y permisos dependen de su catálogo y de la documentación del endpoint.

Authorization: Bearer $GLOOP_API_KEY

Esquemas de autenticación: BearerAuth

Solicitud

Cuerpo de solicitud · application/json

Tipo
object
Campos obligatorios
modelinput

Cuerpo de solicitud obligatorio

  • modelstringObligatorio
  • inputunionObligatorio

    Entrada como cadena o matriz de mensajes

    Rama oneOf 1

    Tipo: string

    Rama oneOf 2

    Tipo: array

    • []objectOpcional
  • instructionsstringOpcional
  • max_output_tokensintegerOpcional
  • temperaturenumberOpcional

    Temperatura de muestreo. Soporte y límites según modelo; sin valores predeterminados uniformes garantizados.

  • top_pnumberOpcional

    Parámetro de muestreo de núcleo. Soporte y límites según modelo; no se garantizan valores predeterminados uniformes.

  • streambooleanOpcional
  • toolsarrayOpcional
    Campos secundarios de tools (1)
    • []objectOpcional
  • tool_choiceunionOpcional
    Rama oneOf 1

    Tipo: string

    Rama oneOf 2

    Tipo: object

  • reasoningobjectOpcional
    Campos secundarios de reasoning (2)
    • effortstringOpcional
      Enumeración
      ["low","medium","high"]
    • summarystringOpcional
  • previous_response_idstringOpcional
  • truncationstringOpcional
    Enumeración
    ["auto","disabled"]
  • parallel_tool_callsbooleanOpcional

    Las llamadas paralelas a herramientas dependen del modelo elegido. Chat acepta un booleano; Responses acepta valores JSON del protocolo compatible.

  • storebooleanOpcional

    La posibilidad de guardar solicitudes y respuestas depende del modelo elegido y de las capacidades admitidas del servicio. Esto no ofrece una API general de almacenamiento de conversaciones.

  • prompt_cache_keystringOpcional

    Identificador de correlación de caché de prompt del servicio; depende del modelo, sin garantía de acierto o soporte. Chat acepta cadenas; Responses, valores JSON del protocolo del servicio.

  • prompt_cache_retentionunknownOpcional

    Valor JSON de control de retención de caché del prompt del servicio; depende del modelo. No hay enumeración, valor predeterminado ni garantía de retención uniformes.

  • service_tierstringOpcional

    Nivel de servicio solicitado, que puede afectar al coste. Se ignora de forma predeterminada y solo se aplica si está admitido. Los valores dependen del modelo elegido.

  • textobjectOpcional

    Configuración de salida de texto, incluido format para salida estructurada; soporte y límites según el modelo.

    Campos secundarios de text (1)
    • formatobjectOpcional

      Formato de texto y salida estructurada según el modelo.

      Campos secundarios de format (4)
      • typestringOpcional

        Identificadores de formatos de salida del modelo elegido.

      • namestringOpcional

        Nombre de salida estructurada.

      • schemaobjectOpcional

        JSON Schema para salida estructurada; debe cumplir los requisitos del modelo.

        Propiedades adicionales
        true
      • strictbooleanOpcional

        Exigir salida estructurada estricta según el soporte del modelo.

  • context_managementunknownOpcional

    Gestión de contexto según el modelo; no garantiza resumen automático ni memoria persistente.

  • stream_optionsobjectOpcional

    Parámetros de streaming Responses con stream=true; solo se aplican los campos admitidos.

    Campos secundarios de stream_options (2)
    • include_usagebooleanOpcional

      Solicitar consumo en streaming; disponibilidad según el modelo.

    • include_obfuscationbooleanOpcional

      Control de ofuscación del flujo Responses; se ignora por defecto y solo se aplica si está admitido.

Respuestas y errores

HTTP 200

Respuesta creada correctamente

application/json

Tipo
object
Propiedades adicionales
false

text/event-stream

Tipo
string
Descripción
Flujo de eventos SSE; eventos, uso y marcadores finales dependen del endpoint. Puede haber errores dentro del flujo.
{
  "type": "string",
  "description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}

HTTP 401

La clave falta, no es válida, caducó o fue revocada.

application/json

Tipo
object
Campos obligatorios
error

HTTP 403

Permisos insuficientes de IP, cuenta, modelo o herramienta.

application/json

Tipo
object
Campos obligatorios
error

HTTP 429

Límite de solicitudes/cola.

application/json

Tipo
object
Campos obligatorios
error

HTTP 500

Fallo interno de autenticación o almacenamiento de datos.

application/json

Tipo
object
Campos obligatorios
error