Use o 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 quando uma resposta pode levar muito tempo para ser concluída, como uso de ferramentas em múltiplas etapas ou tarefas de geração extensas.
A API retorna imediatamente com uma resposta em fila, e você recupera o resultado depois por meio de polling ou streaming.
Criar uma resposta em segundo plano
Definabackground como true e stream como false.
A API cria a resposta, inicia o processamento de forma assíncrona e retorna imediatamente com status: "queued".
id para recuperar o resultado depois.
Consulte o resultado (Polling)
ChameGET /responses/{response_id} até que o status atinja um estado terminal.
| Status | Significado |
|---|---|
queued | A solicitação está aguardando para ser processada |
in_progress | O modelo está gerando a saída |
completed | A geração foi concluída com sucesso |
failed | Ocorreu um erro durante o processamento |
incomplete | A resposta foi interrompida (ex: limite de tokens) |
cancelled | A resposta foi cancelada antes da conclusão |
queued ou in_progress.
Faça streaming de eventos de uma resposta em segundo plano
Se você deseja atualizações em tempo real em vez de polling, recupere a resposta comstream definido como true.
A API retorna eventos enviados pelo servidor à medida que a resposta é processada.
response.completed ou response.failed.
Se a resposta já estiver concluída quando você chamar este endpoint, você receberá um único evento terminal com a resposta final e o stream será encerrado imediatamente.
Faça streaming de eventos no momento da criação
Você também pode fazer streaming de eventos diretamente ao criar uma resposta em segundo plano, definindo tantobackground quanto stream como true.
response.queued, seguido por response.created, eventos intermediários como response.output_text.delta, e finalmente um evento terminal como response.completed.
Isso é útil quando você deseja mostrar o progresso em uma interface enquanto o trabalho é executado em segundo plano.
Se o cliente se desconectar, a resposta continuará sendo processada e poderá ser recuperada posteriormente.
Cancelar uma resposta em segundo plano
Se você não precisar mais do resultado, cancele uma resposta em fila ou em andamento.cancelled.
Respostas que já foram concluídas ou falharam não podem ser canceladas.
Próximos passos
- Veja gerar uma resposta para o básico sobre criação de respostas
- Veja gerenciar agentes quando precisar de definições de agente reutilizáveis e execuções persistentes
- Consulte a referência da API de Respostas para a lista completa de parâmetros e campos de resposta