Skip to main content
GET
/
media
/
{media_id}
Get processing status, embedding and metadata of video 
curl --request GET \
  --url https://api.trytldw.ai/v1/media/{media_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
  "external_id": "video_12345",
  "status": "PENDING",
  "collection_id": "c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
  "title": "My Video",
  "segments": [
    {
      "start_ms": 0,
      "end_ms": 1000,
      "embedding": [
        123
      ],
      "description": "People walking in the park"
    }
  ]
}

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

Examples:

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

​
external_id
string | null
required
Examples:

"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

Examples:

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

​
title
string | null
required
Examples:

"My Video"

​
segments
MediaSegment · object[] | null
required

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