Skip to main content
GET
Get crew result

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

correlation_id
string
required

The crew run's ID.

Response

Successful Response

A crew result plus the visualizations it produced.

The base :class:~shared.models.crew_models.CrewRunResult is markdown and nothing else. Artifacts are recovered by scanning that markdown for analytics links and resolved against the analytics provider at read time — a dashboard's embed carries a short-lived guest token, so it is minted per request and never stored.

Extending rather than replacing keeps the field additive: existing clients that only read result are unaffected.

correlation_id
string
required

The crew run's ID.

status
enum<string>
required

State of the run.

Available options:
pending,
running,
completed,
failed
result
string | null

The crew's output, present only on a successful run.

error
string | null

Why the run failed.

artifacts
AnalyticsArtifact · object[]