Skip to content
CardioAISupport Center

Download PDF report

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

Returns the generated PDF report for a completed task.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organization_path
required
string
>= 1 characters

Unique organization path from organization settings.

task_id
required
integer format: int64
>= 1

Unique task identifier.

Responses

Section titled “Responses”

200

Section titled “200”

PDF report bytes.

Media typeapplication/pdf
string format: binary

400

Section titled “400”

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"
}

401

Section titled “401”

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"
}

403

Section titled “403”

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"
}

404

Section titled “404”

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"
}

409

Section titled “409”

Conflict - current resource state does not allow the operation.

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"
}

429

Section titled “429”

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"
}