Skip to main content
Die OpenAI Tasks API wird verwendet, um die Ergebnisse von zuvor im Callback-Modus an die OpenAI-Bildschnittstelle übermittelten Aufgaben abzufragen. Wenn Sie nicht auf die synchrone HTTP-Antwort warten können oder die Aufgabe später erneut abfragen möchten, verwenden Sie diese Schnittstelle. Im Callback-Modus gibt die ursprüngliche Bildschnittstelle nach der Annahme der Anfrage sofort eine task_id zurück. Sie halten diese task_id direkt und können sie bei Bedarf zur Abfrage an diese Schnittstelle verwenden, ohne eine benutzerdefinierte trace_id zusätzlich übermitteln zu müssen (nur wenn Sie eine eigene Geschäftskennzeichnung zur Verknüpfung verwenden möchten, ist dies erforderlich).
Die Aufgabe wird nur dann persistent gespeichert, wenn die ursprüngliche Bildanfrage eine callback_url enthält. Anfragen, die synchron (nicht im Callback-Modus) aufgerufen werden, werden nicht gespeichert.

Antragsprozess

Die OpenAI Tasks API verwendet die gleiche Autorisierung wie die bestehenden OpenAI-Dienste. Wenn Sie bereits OpenAI Images Generations beantragt haben, können Sie dieselbe Token verwenden, um diese Schnittstelle aufzurufen, ohne eine zusätzliche Anfrage zu stellen. Neue Benutzer haben bei der ersten Anfrage ein kostenloses Kontingent.

Schnittstellenadresse

Unterstützte action:

Anfrageheader

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

Einzelne Aufgabenabfrage (retrieve)

Anfragekörper

id und trace_id müssen mindestens eines übergeben werden. In der Regel verwenden Sie einfach die id aus der Antwort der Einreichung, trace_id wird nur übermittelt, wenn Sie eine benutzerdefinierte Geschäftskennzeichnung zur Verknüpfung verwenden möchten.

Codebeispiel

CURL

Python

Rückgabe-Beispiel

Wenn die Aufgabe vorhanden ist:
Wenn keine Aufgabe gefunden wird, wird ein leeres Objekt zurückgegeben:

Feldbeschreibung

  • id: Die beim Bearbeiten der ursprünglichen Bildanfrage generierte Aufgaben-ID.
  • trace_id: Die benutzerdefinierte Verfolgungskennzeichnung, die in der ursprünglichen Anfrage übermittelt wurde, um die Verknüpfung mit der Geschäftslogik des Clients zu erleichtern.
  • type: Aufgabentyp. Aufgaben, die in der gpt-image-Serie (z. B. gpt-image-2) geschrieben werden, sind images; gpt-image-1, nano-banana usw. verwenden images_generations / images_edits, einige Chat-Schnittstellen sind chat_completions_image.
  • request: Der vollständige Anfragekörper der ursprünglichen Anfrage.
  • response: Der endgültige Antwortkörper, der bei Abschluss des Callbacks zurückgegeben wird.
  • created_at / started_at / finished_at: Unix-Zeitstempel (Sekunden, Fließkomma).
  • elapsed: Ausführungszeit (Sekunden, Fließkomma).
  • application_id / user_id / credential_id: Zugehörige Anwendung, Endbenutzer, Anmeldeinformationen-ID.

Batch-Abfrage (retrieve_batch)

Anfragekörper

Es muss mindestens eines von ids / trace_ids / application_id / user_id oder created_at_* Zeitfenster übergeben werden.

CURL-Beispiel

Rückgabe-Beispiel

End-to-End-Beispiel: Einreichen und Abfragen

Die Tasks-API dient hauptsächlich einem asynchronen Prozess im Callback-Modus. Im Callback-Modus gibt die Einreichschnittstelle sofort eine task_id (d.h. Aufgaben-ID) zurück, die Sie direkt verwenden können, um die Tasks-Schnittstelle abzufragen, ohne selbst eine trace_id zu generieren.

Hinweise

  • Die Tasks-Schnittstelle selbst verursacht keine Kosten, Sie können also bedenkenlos abfragen. Nur die ursprünglichen Bildgenerierungs-/Bearbeitungsanfragen werden berechnet.
  • Nur wenn die ursprüngliche Anfrage callback_url enthält, wird ein Aufgabenprotokoll geschrieben; synchrone Aufrufe erzeugen keine abfragbaren Aufgaben.
  • Aufgabenprotokolle, die die Aufbewahrungsfrist der Plattform überschreiten, können gelöscht werden.