Skip to main content
GET
Get processing status, embedding and metadata of video

Authorizations

Authorization
string
header
required

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

Path Parameters

media_id
string
required

Query Parameters

retrieve_embedding
boolean
default:false
retrieve_description
boolean
default:false

Response

Successful Response

id
string
required

The ID of the video. Use this ID to retrieve task status, metadata and embedding of video

Example:

"c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l"

external_id
string | null
required
Example:

"video_12345"

status
enum<string>
required

The status of the video understanding (e.g. indexing, embedding) job

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
collection_id
string | null
required

The ID of the collection the video belongs to. Only present if the video is indexed in a collection

Example:

"c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l"

title
string | null
required
Example:

"My Video"

segments
MediaSegment · object[] | null
required

Segments of the video with embeddings and/or descriptions if available