Skip to main content
La API de Tareas de OpenAI se utiliza para consultar los resultados de tareas enviadas anteriormente al interfaz de imágenes de OpenAI en modo de callback. Cuando no puede esperar una respuesta HTTP sincrónica, o desea consultar la tarea nuevamente más tarde, utilice esta interfaz. En modo de callback, la interfaz de imágenes original devolverá inmediatamente un task_id después de aceptar la solicitud. Usted posee directamente este task_id y puede usarlo para consultar esta interfaz cuando lo necesite, sin necesidad de pasar un trace_id personalizado (solo es necesario si desea asociarlo con un identificador de negocio propio).
La tarea solo se persistirá si la solicitud de imagen original incluye un callback_url. Las solicitudes realizadas de manera sincrónica (no en modo de callback) no se almacenarán.

Proceso de Solicitud

La API de Tareas de OpenAI comparte la autorización con los servicios existentes de OpenAI. Si ya ha solicitado Generaciones de Imágenes de OpenAI, puede utilizar el mismo token para llamar a esta interfaz, sin necesidad de solicitar uno adicional. Los nuevos usuarios tienen un límite gratuito en su primera solicitud.

Dirección de la Interfaz

Acciones soportadas:

Encabezados de Solicitud

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

Consulta de Tarea Única (retrieve)

Cuerpo de Solicitud

Se debe proporcionar al menos uno de id o trace_id. En general, se puede usar directamente el id de la respuesta de la solicitud, y trace_id solo se debe pasar si desea asociarlo con un identificador de negocio personalizado.

Ejemplo de Código

CURL

Python

Ejemplo de Respuesta

Cuando la tarea existe:
Cuando no se encuentra ninguna tarea, se devuelve un objeto vacío:

Descripción de Campos

  • id: ID de tarea generado al aceptar la solicitud de imagen original.
  • trace_id: Identificador de seguimiento personalizado pasado en la solicitud original, útil para asociar con el negocio del cliente.
  • type: Tipo de tarea. Las tareas escritas en la serie gpt-image (como gpt-image-2) son images; gpt-image-1, nano-banana, etc., utilizan images_generations / images_edits, y algunas interfaces de chat son chat_completions_image.
  • request: Cuerpo completo de la solicitud original.
  • response: Cuerpo de respuesta final devuelto al completar el callback.
  • created_at / started_at / finished_at: Marca de tiempo Unix (segundos, flotante).
  • elapsed: Tiempo de ejecución (segundos, flotante).
  • application_id / user_id / credential_id: ID de la aplicación, usuario final y credencial.

Consulta por Lotes (retrieve_batch)

Cuerpo de Solicitud

Se debe proporcionar al menos uno de ids / trace_ids / application_id / user_id o el rango de tiempo created_at_*.

Ejemplo de CURL

Ejemplo de Respuesta

Ejemplo de extremo a extremo: enviar y sondear

La API de Tasks sirve principalmente para procesos asíncronos en modo de callback. En modo de callback, la interfaz de envío devuelve inmediatamente un task_id (es decir, ID de tarea), después solo necesita usar este task_id para sondear la interfaz de Tasks, sin necesidad de generar un trace_id por su cuenta.

Consideraciones

  • La interfaz de Tasks no genera costos, puede sondear sin preocupaciones. Solo las solicitudes originales de generación/edición de imágenes incurrirán en costos.
  • Solo cuando la solicitud original incluya callback_url, se registrará la tarea; las llamadas sincrónicas no generarán tareas consultables.
  • Los registros de tareas que superen el período de retención de la plataforma pueden ser eliminados.