Skip to content

Get analysis status

GET
/analyses/{analysis_id}/status
curl --request GET \
--url https://example.com/analyses/example/status

Retrieve the status of a specific analysis.

analysis_id
required
string

Analysis status retrieved

Media type application/json
object
status
required
string
Allowed values: PENDING IN_PROGRESS COMPLETED FAILED
message

Additional information about the status (e.g., failure reason).

string
Example
{
"status": "PENDING"
}

Unauthorized

Media type application/json
object
error_code
required

A unique error code identifying the issue.

string
message
required

A human-readable error message.

string
Example generated
{
"error_code": "example",
"message": "example"
}

Forbidden

Media type application/json
object
error_code
required

A unique error code identifying the issue.

string
message
required

A human-readable error message.

string
Example generated
{
"error_code": "example",
"message": "example"
}

No analysis found with ID {analysis_id}

Media type application/json
object
error_code
required

A unique error code identifying the issue.

string
message
required

A human-readable error message.

string
Example generated
{
"error_code": "example",
"message": "example"
}