Zum Hauptinhalt springen
POST
Digital Human Tasks

Autorisierungen

Authorization
string
header
erforderlich

Body

application/json

Use one ID for polling, retrieve, or delete. Use action=retrieve_batch without an ID to list recent history. To retrieve a chosen set of IDs, send individual retrieve requests.

action
enum<string>
erforderlich

Omit for a flat result, use retrieve for one detailed task, delete for one task, or retrieve_batch to list the authenticated caller's recent tasks. retrieve_batch does not query an array of IDs.

Verfügbare Optionen:
retrieve_batch
task_id
string

One task identifier for flat polling, retrieve, or delete. Not an ID array. retrieve_batch ignores this field and lists recent history.

Beispiel:

"task_49af42c410c24f04ad416b28af55d237"

id
string

Alternative to task_id for a single retrieve or delete request.

limit
integer
Standard:20

Maximum number of recent tasks for retrieve_batch.

Erforderlicher Bereich: 1 <= x <= 100
created_at_min
integer

For retrieve_batch: only tasks created strictly after this Unix timestamp in seconds.

created_at_max
integer

For retrieve_batch: only tasks created strictly before this Unix timestamp in seconds.

type
enum<string>

Optional retrieve_batch history kind filter.

Verfügbare Optionen:
videos,
voices

Antwort

OK

Flat task result when action is omitted. Video or voice output fields appear when available.

success
boolean
erforderlich

Whether the task query succeeded.

task_id
string
erforderlich

Asynchronous task identifier.

trace_id
string | null
erforderlich

Request trace identifier.

state
string
erforderlich

Current task state.

progress
number
erforderlich

Completion percentage from 0 to 100.

video_url
string<uri>

Generated video URL when available.

duration
number

Length of the generated video in seconds — not the task's processing time.

width
number

Generated video width in pixels.

height
number

Generated video height in pixels.

engine
string

Rendering engine selected for the task.

voice_id
string

Cloned voice ID when the voice task has completed.

error
string

Task failure detail when present.