Skip to main content
GET
Video Analysis Detail

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

video_analysis_id
string
required
organization_id
string
required
workspace_id
string
required

Response

Successful Response

id
string
required
status
string
required

pending, running, completed or failed.

generation_used
integer
required

Generations charged for this analysis, frozen at trigger time.

created_at
string<date-time>
required

When the analysis was requested and charged.

video
VideoAnalysisVideoResponse · object
required
creator
VideoAnalysisCreatorResponse · object
required
triggered_by
string
required

Id of the user who requested the analysis.

completed_at
string<date-time> | null

When the analysis reached a terminal state. Absent while it is still running.

current_step
string | null

The pipeline step last reported by the flow. Absent before it starts.

error_message
string | null

Why the analysis failed. Absent unless it did.

results
Results · object | null

The analysis payload, returned exactly as the pipeline wrote it. Absent until the analysis is completed, so a pending, running or failed analysis is a 200 with no results rather than a 404.