Skip to main content
A API de Tarefas OpenAI é usada para consultar os resultados de tarefas submetidas anteriormente ao interface de imagem da OpenAI em modo de callback. Quando você não pode esperar por uma resposta HTTP síncrona ou deseja consultar a tarefa novamente mais tarde, use esta interface. No modo de callback, a interface de imagem original retornará imediatamente um task_id após aceitar o pedido. Você possui diretamente esse task_id e pode usá-lo para consultar esta interface quando necessário, sem precisar passar um trace_id personalizado (apenas se você desejar associar com um identificador de negócio próprio).
As tarefas só serão persistidas se o pedido de imagem original incluir um callback_url. Pedidos feitos de forma síncrona (não em callback) não serão armazenados.

Processo de Solicitação

A API de Tarefas OpenAI compartilha a autorização com os serviços existentes da OpenAI. Se você já solicitou a Geração de Imagens da OpenAI, pode usar diretamente o mesmo token para chamar esta interface, sem necessidade de solicitação adicional. Novos usuários têm uma cota gratuita na primeira solicitação.

Endereço da Interface

Ações suportadas:

Cabeçalhos da Solicitação

  • accept: application/json
  • authorization: Bearer {token}
  • content-type: application/json

Consulta de Tarefa Única (retrieve)

Corpo da Solicitação

É necessário passar pelo menos um dos campos id ou trace_id. Normalmente, você pode usar diretamente o id da resposta de submissão; o trace_id deve ser passado apenas se você desejar associar com um identificador de negócio próprio.

Exemplo de Código

CURL

Python

Exemplo de Retorno

Quando a tarefa existe:
Quando nenhuma tarefa é encontrada, retorna um objeto vazio:

Descrição dos Campos

  • id: ID da tarefa gerado quando o pedido de imagem original foi aceito.
  • trace_id: Identificador de rastreamento personalizado passado na solicitação original, facilitando a associação com o negócio do cliente.
  • type: Tipo de tarefa. Tarefas escritas na série gpt-image (como gpt-image-2) são images; gpt-image-1, nano-banana, etc., usam images_generations / images_edits, e algumas interfaces de chat são chat_completions_image.
  • request: Corpo completo da solicitação original.
  • response: Corpo da resposta final retornada quando o callback é concluído.
  • created_at / started_at / finished_at: Timestamp Unix (segundos, ponto flutuante).
  • elapsed: Tempo de execução (segundos, ponto flutuante).
  • application_id / user_id / credential_id: ID do aplicativo, usuário final e credencial.

Consulta em Lote (retrieve_batch)

Corpo da Solicitação

Você pode passar um dos campos ids / trace_ids / application_id / user_id ou a janela de tempo created_at_*.

Exemplo CURL

Exemplo de Retorno

Exemplo de ponta a ponta: Submissão e Polling

A API de Tarefas serve principalmente para processos assíncronos no modo de callback. No modo de callback, a interface de submissão retorna imediatamente um task_id (ou seja, ID da tarefa), depois você só precisa usar esse task_id para fazer polling na interface de Tarefas, sem precisar gerar um trace_id por conta própria.

Observações

  • A interface de Tarefas não gera custos, você pode fazer polling à vontade. Apenas as solicitações de geração/edição de imagem originais serão cobradas.
  • Apenas quando a solicitação original contém callback_url, a gravação da tarefa será feita; chamadas síncronas não gerarão tarefas consultáveis.
  • Registros de tarefas que excederem o período de retenção da plataforma podem ser limpos.