Skip to main content
cURL

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

​
taskId
string<uuid>
required

The background task id.

Response

Status OK.

​
id
string<uuid>
required
read-only

The background task id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
name
string
required
read-only

The task's internal name, including the arguments it was queued with.

Example:

"ExportFrameworkRunner(framework_id=9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70, project_id=None)"

​
progress
number<float>
required

How far along the task is, from 0 to 100.

Required range: 0 <= x <= 100
Example:

95

​
complete
boolean
required

Whether the task has finished. Check this before reading outputs.

​
dateCreated
string<date-time>
required
read-only

When the task was queued.

Example:

"2026-09-15T11:31:01.185Z"

​
dateUpdated
string<date-time>
required
read-only

When the task last reported progress.

Example:

"2026-09-15T11:33:47.902Z"

​
error
string | null

Why the task failed, or null if it has not failed.

​
outputs
object | null

Whatever the task produced, keyed by name. null until the task completes. A framework export returns storageUri -- pass it to GET /storage/presigned-url to download the archive -- along with filename, controlCount, evidenceCount and missingEvidenceCount.

Example: