v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB

Tasks

Get task

Return the status of a task.

get/tasks/{taskid}

Path parameters

taskidstring required

Task ID

Example:sampleTaskID1234567890abcdef0000

Response

Task

idstring required

Task ID

status'pending' | 'running' | 'canceled' | 'done' required

percentnumber required

endedstring date-time

RFC 3339, section 5.6

{"stackTrail":"components:schemas:Task:properties:result","oasType":"schema","type":"unknown","description":"The result can be of any type, depending on the task","extensionFields":{"x-go-type":"json.RawMessage"}}

errorstring

Example response

{
  "id": "sampleTaskID1234567890abcdef0000",
  "status": "pending",
  "percent": 42,
  "ended": "2024-04-24T17:42:28Z"
}