Skip to main content
GET
Retrieve task
Video and image tasks share /v1/tasks/{task_id}. After submitting /v1/videos/generations, retrieve the returned task_id and poll this endpoint.

Request

In-progress response

Successful response

After the task reaches completed, retrieve the resulting video from /v1/videos/{task_id}/content with Bearer authentication.
If your product displays videos to end users, proxy this download through your server: use the key to retrieve the video, then deliver it under your own authentication so the DimiLinks key is never exposed to the browser.

Failed response

Status values

Polling recommendations

  • Poll every three to five seconds, slightly less frequently than for image tasks.
  • Poll an individual task for at most ten minutes. After the timeout, tell the user the task failed and allow a retry.
  • Stop polling immediately on 404; the task ID is probably incorrect or does not belong to the current key.

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