POST
/
collections
/
{collection_id}
/
youtube
curl --request POST \
  --url https://api.cloudglue.dev/v1/collections/{collection_id}/youtube \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "metadata": {}
}'
{
  "collection_id": "<string>",
  "file_id": "<string>",
  "object": "collection_file",
  "added_at": 123,
  "status": "pending",
  "describe_status": "pending",
  "extract_status": "pending",
  "searchable_status": "pending",
  "file": {
    "id": "<string>",
    "status": "pending",
    "bytes": 123,
    "created_at": 123,
    "filename": "<string>",
    "uri": "<string>",
    "metadata": {},
    "video_info": {
      "duration_seconds": 123,
      "height": 123,
      "width": 123,
      "format": "<string>",
      "has_audio": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
collection_id
string
required

The ID of the collection to add the YouTube video to

Body

application/json
YouTube video URL parameters
​
url
string
required

The URL of the YouTube video to add to the collection.

Note that YouTube videos are currently limited to speech and metadata level understanding, for fully fledge multimodal video understanding please upload a file instead to the Files API and use that object instead as input.

​
metadata
object

User-provided metadata about the YouTube video

Response

200
application/json
Successful video addition
​
collection_id
string
required

ID of the collection

​
file_id
string
required

ID of the file

​
object
enum<string>
required

Object type, always 'collection_file'

Available options:
collection_file
​
added_at
integer
required

Unix timestamp of when the file was added to the collection

​
status
enum<string>
required

Overall processing status of the file in this collection

Available options:
pending,
processing,
ready,
completed,
failed,
not_applicable
​
describe_status
enum<string>

Status of the video description processing

Available options:
pending,
processing,
ready,
completed,
failed,
not_applicable
​
extract_status
enum<string>

Status of the entity extraction processing

Available options:
pending,
processing,
ready,
completed,
failed,
not_applicable
​
searchable_status
enum<string>

Status of the searchable index processing

Available options:
pending,
processing,
ready,
completed,
failed,
not_applicable
​
file
object

The file object