background quando uma resposta pode demorar para ser concluida, como no uso de ferramentas em multiplas etapas ou tarefas de geracao extensas.
A API retorna imediatamente com uma resposta enfileirada, e voce obtem o resultado depois por 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 assincrona e retorna imediatamente com status: "queued".
id para obter o resultado posteriormente.
Consultar o resultado por polling
ChameGET /responses/{response_id} ate que o status alcance um estado terminal.
| Status | Significado |
|---|---|
queued | A requisicao esta aguardando para ser processada |
in_progress | O modelo esta gerando a saida |
completed | A geracao foi concluida com sucesso |
failed | Ocorreu um erro durante o processamento |
incomplete | A resposta foi interrompida (ex.: limite de tokens) |
cancelled | A resposta foi cancelada antes de ser concluida |
queued ou in_progress.
Transmitir eventos de uma resposta em segundo plano
Se voce quiser atualizacoes em tempo real em vez de polling, obtenha a resposta comstream definido como true.
A API retorna eventos server-sent conforme a resposta e processada.
response.completed ou response.failed.
Se a resposta ja tiver sido concluida quando voce chamar esse endpoint, voce recebera um unico evento terminal com a resposta final e o stream sera encerrado imediatamente.
Transmitir eventos no momento da criacao
Voce tambem pode transmitir eventos diretamente ao criar uma resposta em segundo plano, definindo tantobackground quanto stream como true.
response.queued, seguido por response.created, eventos intermediarios como response.output_text.delta e, por fim, um evento terminal como response.completed.
Isso e util quando voce quer mostrar o progresso em uma interface enquanto o trabalho e executado em segundo plano.
Se o cliente desconectar, a resposta continua sendo processada e pode ser obtida posteriormente.
Cancelar uma resposta em segundo plano
Se voce nao precisar mais do resultado, cancele uma resposta enfileirada ou em andamento.cancelled.
Respostas que ja foram concluidas ou falharam nao podem ser canceladas.
Proximos passos
- Veja gerar uma resposta para os conceitos basicos de criacao de respostas
- Veja criar subagentes usando a API Responses para combinar respostas em segundo plano com fluxos baseados em ferramentas
- Consulte a referencia da API Responses para a lista completa de parametros e campos de resposta