Referencia de API
Crear una respuesta (OpenAI Responses API)
/v1/responsesInterfaz 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_KEYEsquemas de autenticación: BearerAuth
Solicitud
Cuerpo de solicitud · application/json
- Tipo
- object
- Campos obligatorios
modelinput
Cuerpo de solicitud obligatorio
modelstringObligatorioinputunionObligatorioEntrada como cadena o matriz de mensajes
Rama oneOf 1
Tipo: string
instructionsstringOpcionalmax_output_tokensintegerOpcionaltemperaturenumberOpcionalTemperatura de muestreo. Soporte y límites según modelo; sin valores predeterminados uniformes garantizados.
top_pnumberOpcionalParámetro de muestreo de núcleo. Soporte y límites según modelo; no se garantizan valores predeterminados uniformes.
streambooleanOpcionaltoolsarrayOpcionalCampos secundarios de tools (1)
[]objectOpcional
tool_choiceunionOpcionalRama oneOf 1
Tipo: string
Rama oneOf 2
Tipo: object
reasoningobjectOpcionalprevious_response_idstringOpcionaltruncationstringOpcional- Enumeración
["auto","disabled"]
parallel_tool_callsbooleanOpcionalLas llamadas paralelas a herramientas dependen del modelo elegido. Chat acepta un booleano; Responses acepta valores JSON del protocolo compatible.
storebooleanOpcionalLa 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_keystringOpcionalIdentificador 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_retentionunknownOpcionalValor 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_tierstringOpcionalNivel 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.
textobjectOpcionalConfiguración de salida de texto, incluido format para salida estructurada; soporte y límites según el modelo.
Campos secundarios de text (1)
formatobjectOpcionalFormato de texto y salida estructurada según el modelo.
Campos secundarios de format (4)
typestringOpcionalIdentificadores de formatos de salida del modelo elegido.
namestringOpcionalNombre de salida estructurada.
schemaobjectOpcionalJSON Schema para salida estructurada; debe cumplir los requisitos del modelo.
- Propiedades adicionales
true
strictbooleanOpcionalExigir salida estructurada estricta según el soporte del modelo.
context_managementunknownOpcionalGestión de contexto según el modelo; no garantiza resumen automático ni memoria persistente.
stream_optionsobjectOpcionalParámetros de streaming Responses con stream=true; solo se aplican los campos admitidos.
Campos secundarios de stream_options (2)
include_usagebooleanOpcionalSolicitar consumo en streaming; disponibilidad según el modelo.
include_obfuscationbooleanOpcionalControl 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
idstringOpcionalobjectstringOpcionalcreated_atintegerOpcionalstatusstringOpcional- Enumeración
["completed","failed","in_progress","incomplete"]
modelstringOpcionaloutputarrayOpcionalCampos secundarios de output (1)
[]objectOpcional- Propiedades adicionales
false
Campos secundarios de [] (8)
typestringOpcionalidstringOpcionalstatusstringOpcionalrolestringOpcionalcontentarrayOpcionalCampos secundarios de content (1)
[]objectOpcional- Propiedades adicionales
false
Campos secundarios de [] (3)
typestringOpcional- Enumeración
["output_text","refusal"]
textstringOpcionalannotationsarrayOpcionalCampos secundarios de annotations (1)
[]objectOpcional
call_idstringOpcionalnamestringOpcionalargumentsstringOpcional
usageobjectOpcionalCampos secundarios de usage (5)
prompt_tokensintegerOpcionalTokens del prompt
completion_tokensintegerOpcionalTokens de compleción
total_tokensintegerOpcionalTotal de tokens
prompt_tokens_detailsobjectOpcionalCampos secundarios de prompt_tokens_details (4)
cached_tokensintegerOpcionaltext_tokensintegerOpcionalaudio_tokensintegerOpcionalimage_tokensintegerOpcional
completion_tokens_detailsobjectOpcionalCampos secundarios de completion_tokens_details (3)
text_tokensintegerOpcionalaudio_tokensintegerOpcionalreasoning_tokensintegerOpcional
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
errorobjectObligatorioCampos secundarios de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional
HTTP 403
Permisos insuficientes de IP, cuenta, modelo o herramienta.
application/json
- Tipo
- object
- Campos obligatorios
error
errorobjectObligatorioCampos secundarios de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional
HTTP 429
Límite de solicitudes/cola.
application/json
- Tipo
- object
- Campos obligatorios
error
errorobjectObligatorioCampos secundarios de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional
HTTP 500
Fallo interno de autenticación o almacenamiento de datos.
application/json
- Tipo
- object
- Campos obligatorios
error
errorobjectObligatorioCampos secundarios de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional