Skip to content

Get task status

GET
/v3/orgs/{organization_path}/tasks/{task_id}/status
curl --request GET \
--url https://api.cardio.ai/v3/orgs/example/tasks/1/status \
--header 'X-Api-Token: <X-Api-Token>'

Returns creation time, processing state, report availability, and severity level.

organization_path
required
string
>= 1 characters

Unique organization path from organization settings.

task_id
required
integer format: int64
>= 1

Unique task identifier.

Metadata successfully retrieved.

Media typeapplication/json

Metadata status of a task.

object
creation_time
required

Task creation timestamp in RFC 3339 format.

string format: date-time
processed
required

Indicates whether the task has been processed.

boolean
report_available
required

Indicates whether a review report is available for the task.

boolean
severity

Severity level assigned to the task. Omitted if undefined.

string
Allowed values: NONE LOW MODERATE IMPORTANT CRITICAL
Example
{
"severity": "NONE"
}

Bad Request - missing or invalid parameters.

Media typeapplication/json

Error payload carried by every non-2xx response.

object
message
required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string
reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string
Examplegenerated
{
"message": "example",
"reason": "example"
}

Unauthorized - missing, expired, or invalid token.

Media typeapplication/json

Error payload carried by every non-2xx response.

object
message
required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string
reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string
Examplegenerated
{
"message": "example",
"reason": "example"
}

Forbidden - the provided token is not authorized to call this endpoint.

Media typeapplication/json

Error payload carried by every non-2xx response.

object
message
required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string
reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string
Examplegenerated
{
"message": "example",
"reason": "example"
}

Not Found - requested resource does not exist or is unavailable.

Media typeapplication/json

Error payload carried by every non-2xx response.

object
message
required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string
reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string
Examplegenerated
{
"message": "example",
"reason": "example"
}

Too Many Requests - rate limit exceeded.

Media typeapplication/json

Error payload carried by every non-2xx response.

object
message
required

Human-readable description of the failure. The wording is not part of the API contract; do not match on it programmatically.

string
reason

Stable machine-readable failure code in snake_case, e.g. “api_token_missing” or “invalid_task_id”. Omitted for 500 responses.

string
Examplegenerated
{
"message": "example",
"reason": "example"
}