Skip to main content
GET
Retrieve task
After submitting an asynchronous image task, use its task_id to retrieve the status. New integrations should prefer /v1/tasks/{task_id}.

Request

In-progress response

Successful response

Image URL formats

After the task succeeds, read result.data[].url. It may be a relative path, a complete HTTP(S) URL, or a data:image/...;base64,... Data URL. A Data URL is neither an error nor log output; it is the image itself. A webpage can display it directly, while a script must decode the base64 before saving it as a file.

Failed response

Status values

Legacy route

GET /v1/images/tasks/{task_id} remains available for legacy clients. New integrations should not mix the two response structures. Example response from the legacy route:

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

task_id
string
required

Response

Image or video task

id
string
Example:

"img_xxx"

task_id
string
Example:

"img_xxx"

object
string
Example:

"image.task"

status
enum<string>
Available options:
queued,
in_progress,
succeeded,
failed
progress
integer
Required range: 0 <= x <= 100
created_at
integer
completed_at
integer
result
object
error
object