Skip to main content
GET
Retrieve a task status

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer <API_KEY>.

Query Parameters

task_id
string
required

Task ID returned by run-task or run-task-by-template.

Minimum string length: 1

Response

OK

Lightweight response containing only the task status.

status
enum<string>
required

Current task status.

  • created: Task is created but not yet running
  • running: Task is currently executing
  • finished: Task completed successfully
  • canceled: Task was canceled (e.g., via Stop Task)
  • pausing: Task is transitioning into paused state
  • paused: Task is paused and can be resumed
  • failed: Task ended with an error
  • unknown: Unknown or unsupported status
Available options:
created,
running,
finished,
canceled,
pausing,
paused,
failed,
unknown