Skip to main content
L’API OpenAI Tasks est utilisée pour interroger les résultats des tâches soumises précédemment au biais de mode de rappel à l’interface d’image d’OpenAI. Lorsque vous ne pouvez pas attendre une réponse HTTP synchrone, ou si vous souhaitez interroger à nouveau la tâche ultérieurement, veuillez utiliser cette interface. En mode de rappel, l’interface d’image d’origine renverra immédiatement un task_id après avoir accepté la demande. Vous détenez directement ce task_id et pouvez l’utiliser pour interroger cette interface lorsque nécessaire, sans avoir à transmettre un trace_id personnalisé (sauf si vous souhaitez établir une association avec votre propre identifiant commercial).
Les tâches ne seront persistées que si la demande d’image d’origine contient un callback_url. Les demandes effectuées de manière synchrone (non en mode de rappel) ne seront pas stockées.

Processus de demande

L’API OpenAI Tasks partage l’autorisation avec les services OpenAI existants. Si vous avez déjà demandé des générations d’images OpenAI, vous pouvez directement utiliser le même token pour appeler cette interface, sans demande supplémentaire. Les nouveaux utilisateurs bénéficient d’un quota gratuit lors de leur première demande.

Adresse de l’API

Actions supportées :

En-têtes de requête

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

Interrogation d’une tâche unique (retrieve)

Corps de la requête

Il faut transmettre au moins id ou trace_id. En général, il suffit d’utiliser directement l’id de la réponse de soumission, trace_id n’est à transmettre que si vous souhaitez établir une association avec un identifiant commercial personnalisé.

Exemple de code

CURL

Python

Exemple de réponse

Lorsque la tâche existe :
Lorsque aucune tâche n’est trouvée, renvoie un objet vide :

Description des champs

  • id : ID de tâche généré lors de l’acceptation de la demande d’image d’origine.
  • trace_id : Identifiant de suivi personnalisé transmis dans la demande d’origine, facilitant l’association avec les activités commerciales du client.
  • type : Type de tâche. Les tâches écrites pour la série gpt-image (comme gpt-image-2) sont de type images ; gpt-image-1, nano-banana, etc. utilisent images_generations / images_edits, certaines interfaces de chat sont de type chat_completions_image.
  • request : Corps complet de la demande d’origine.
  • response : Corps de réponse final retourné lors de l’achèvement du rappel.
  • created_at / started_at / finished_at : Horodatages Unix (secondes, flottant).
  • elapsed : Temps d’exécution (secondes, flottant).
  • application_id / user_id / credential_id : ID de l’application, de l’utilisateur final, et des identifiants de crédentiel.

Interrogation par lot (retrieve_batch)

Corps de la requête

Il suffit de transmettre l’un des ids / trace_ids / application_id / user_id ou des fenêtres temporelles created_at_*.

Exemple CURL

Exemple de réponse

Exemple de bout en bout : soumettre et interroger

L’API Tasks sert principalement à un processus asynchrone en mode de rappel. En mode de rappel, l’interface de soumission renverra immédiatement un task_id (c’est-à-dire l’ID de la tâche), après quoi vous n’avez qu’à utiliser ce task_id pour interroger l’interface Tasks, sans avoir à générer vous-même un trace_id.

Remarques

  • L’interface Tasks elle-même n’entraîne pas de frais, vous pouvez interroger sans souci. Seules les demandes de génération/édition d’images originales seront facturées.
  • Les enregistrements de tâches ne seront écrits que si la demande originale contient callback_url ; les appels synchrones ne produiront pas de tâches consultables.
  • Les enregistrements de tâches dépassant la période de conservation de la plateforme peuvent être nettoyés.