Utiliza el modoDocumentation Index
Fetch the complete documentation index at: https://docs.mka1.com/llms.txt
Use this file to discover all available pages before exploring further.
background cuando una respuesta pueda tardar mucho tiempo en completarse, como en el uso de herramientas de varios pasos o tareas de generación grandes.
La API responde de inmediato con una respuesta en cola, y puedes recuperar el resultado más tarde mediante sondeo o streaming.
Crear una respuesta en segundo plano
Establecebackground en true y stream en false.
La API crea la respuesta, comienza a procesarla de forma asíncrona y responde de inmediato con status: "queued".
id para recuperar el resultado más adelante.
Sondear para obtener el resultado
Llama aGET /responses/{response_id} hasta que el estado alcance un estado terminal.
| Estado | Significado |
|---|---|
queued | La solicitud está esperando ser procesada |
in_progress | El modelo está generando la salida |
completed | La generación finalizó correctamente |
failed | Ocurrió un error durante el procesamiento |
incomplete | La respuesta se cortó (por ejemplo, límite de tokens) |
cancelled | La respuesta fue cancelada antes de completarse |
queued o in_progress.
Recibir eventos de una respuesta en segundo plano
Si deseas actualizaciones en tiempo real en lugar de sondeo, recupera la respuesta constream establecido en true.
La API devuelve eventos enviados por el servidor a medida que se procesa la respuesta.
response.completed o response.failed.
Si la respuesta ya se ha completado cuando llamas a este endpoint, recibes un solo evento terminal con la respuesta final y el flujo se cierra inmediatamente.
Recibir eventos al momento de la creación
También puedes recibir eventos directamente al crear una respuesta en segundo plano estableciendo tantobackground como stream en true.
response.queued, seguido de response.created, eventos intermedios como response.output_text.delta y finalmente un evento terminal como response.completed.
Esto es útil cuando quieres mostrar el progreso en una interfaz de usuario mientras el trabajo se ejecuta en segundo plano.
Si el cliente se desconecta, la respuesta sigue procesándose y puede recuperarse más tarde.
Cancelar una respuesta en segundo plano
Si ya no necesitas el resultado, cancela una respuesta en cola o en progreso.cancelled.
Las respuestas que ya han finalizado o fallado no pueden ser canceladas.
Próximos pasos
- Consulta generar una respuesta para lo básico sobre la creación de respuestas
- Consulta gestionar agentes cuando necesites definiciones de agente reutilizables y ejecuciones persistentes
- Revisa la referencia de la API de Responses para la lista completa de parámetros y campos de respuesta