Index videos in a collection

POST

media

curl --request POST \
  --url https://api.trytldw.ai/v1/media/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collection_id": "c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
  "media_list": {
    "external_id": "video_1",
    "title": "My Video1",
    "url": "https//example.com/video1.mp4"
  }
}'

{
  "media_list": [
    {
      "id": "c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "external_id": "video_12345",
      "status": "PENDING"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

collection_id

string

required

The ID of the collection to add the video to

Example:

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

media_list

object[]

required

List of videos to add. Maximum 10 media can be added per request

media_list.url

string

required

The http or https URL to the raw video file. URL link to web page containing the video (e.g. Youtube Link), cloud storage services uri (e.g. uri starts with gs://) are not supported.

Example:

"https://example.com/video.mp4"

media_list.external_id

string | null

User-defined media identifier

Example:

"video_12345"

media_list.title

string | null

The title of the media displayed in the search results

Example:

"My Video"

media_list.metadata

object | null

User-defined media metadata, including ownership, geo location, etc. Key names can NOT start with underscore

Example:

{
  "location": { "lat": 1, "lon": 2 },
  "owner_id": "user_123"
}

Example:

{
  "external_id": "video_1",
  "title": "My Video1",
  "url": "https//example.com/video1.mp4"
}

Response

200

application/json

Successful Response

media_list

object[]

required

Was this page helpful?

Suggest edits Raise issue

No-code Playground Delete videos by ID

curl --request POST \
  --url https://api.trytldw.ai/v1/media/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collection_id": "c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
  "media_list": {
    "external_id": "video_1",
    "title": "My Video1",
    "url": "https//example.com/video1.mp4"
  }
}'

{
  "media_list": [
    {
      "id": "c1a2b3c4-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "external_id": "video_12345",
      "status": "PENDING"
    }
  ]
}

Get Started

API Reference

Index videos in a collection

Authorizations

Body

Response