Skip to main content
OpenAI Tasks API används för att hämta resultatet av uppgifter som tidigare har skickats till OpenAI:s bildgränssnitt i callback-läge. När du inte kan vänta på en synkron HTTP-respons, eller vill fråga om uppgiften i efterhand, använd detta gränssnitt. I callback-läge, återger det ursprungliga bildgränssnittet omedelbart ett task_id efter att ha tagit emot begäran. Du har direkt detta task_id, och när du behöver det kan du använda det för att fråga detta gränssnitt, utan att behöva skicka en anpassad trace_id (endast om du vill koppla det till din egen affärsidentifierare).
Uppgiften kommer endast att sparas om den ursprungliga bildbegäran innehöll en callback_url. Begärningar som görs på ett synkront (icke-callback) sätt kommer inte att lagras.

Ansökningsprocess

OpenAI Tasks API delar auktorisering med befintliga OpenAI-tjänster. Om du redan har ansökt om OpenAI Images Generations kan du direkt använda samma token för att anropa detta gränssnitt, utan att behöva ansöka om något ytterligare. Nya användare har en gratis kvot vid första ansökan.

Gränssnittsadress

Stödda action:

Begärningshuvud

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

Enskild uppgiftshämtning (retrieve)

Begärningskropp

Antingen id eller trace_id måste anges. I allmänhet kan du direkt använda id från svaret på begäran, trace_id bör endast anges om du vill koppla det till en anpassad affärsidentifierare.

Kodexempel

CURL

Python

Exempel på svar

När uppgiften finns:
När ingen uppgift matchas returneras ett tomt objekt:

Fältbeskrivning

  • id: Uppgiftens ID som genererades när den ursprungliga bildbegäran behandlades.
  • trace_id: Den anpassade spårningsidentifieraren som skickades i den ursprungliga begäran, för att underlätta kopplingen till klientens affär.
  • type: Uppgiftstyp. Uppgifter skrivna med gpt-image-serien (som gpt-image-2) är images; gpt-image-1, nano-banana etc. använder images_generations / images_edits, vissa chattgränssnitt är chat_completions_image.
  • request: Den fullständiga begärningskroppen för den ursprungliga begäran.
  • response: Den slutliga responskroppen som returneras när callbacken är klar.
  • created_at / started_at / finished_at: Unix-tidsstämpel (sekunder, flyttal).
  • elapsed: Utförandetid (sekunder, flyttal).
  • application_id / user_id / credential_id: Tillhörande applikation, slutanvändare, autentiserings-ID.

Batchhämtning (retrieve_batch)

Begärningskropp

Antingen ids / trace_ids / application_id / user_id eller created_at_* tidsfönster kan anges.

CURL-exempel

Exempel på svar

End-to-end exempel: Skicka och pollera

Tasks API tjänar främst för asynkrona processer i callback-läge. I callback-läge kommer submit-gränssnittet att omedelbart synkronisera och returnera en task_id (dvs. uppgifts-ID), och därefter behöver du bara använda detta task_id för att pollera Tasks-gränssnittet, utan att själv generera trace_id.

Viktiga punkter

  • Tasks-gränssnittet debiterar inte, så du kan tryggt pollera. Endast de ursprungliga bildgenererings-/redigeringsförfrågningarna kommer att debiteras.
  • Endast när den ursprungliga förfrågan innehåller callback_url kommer uppgiftsregister att skrivas; synkrona anrop kommer inte att generera några sökbara uppgifter.
  • Uppgiftsregister som överskrider plattformens lagringsperiod kan rensas.