Collections

List all files in a collection

Changed on

List all files in a collection

get/collections/{collection_id}/videos

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Path parameters

collection_idstring required

The ID of the collection

Query parameters

limitinteger

Maximum number of files to return

offsetinteger

Number of files to skip

status'pending' | 'processing' | 'completed' | 'failed' | 'not_applicable'

Filter by processing status

added_beforestring date

Filter files added before a specific date (YYYY-MM-DD format), in UTC timezone

added_afterstring date

Filter files added after a specific date (YYYY-MM-DD format), in UTC timezone

order'added_at' | 'filename'

Order the files by a specific field

sort'asc' | 'desc'

Sort the files in ascending or descending order

filterstring

JSON string containing filter criteria to constrain file search results. This is the JSON string version of the SearchFilter object used in the search API.

Supported Filter Types:

• metadata - Filter by file metadata using JSON path expressions (e.g., 'metadata.speaker', 'metadata.category.subcategory') • video_info - Filter by video information properties. Supports optional scope ('file' or 'segment', default 'file')

  • duration_seconds - Video/segment duration in seconds (supports file and segment scope)
  • has_audio - Whether the video has audio (true/false, file scope only)

• file - Filter by file properties

  • filename - File name (string)
  • uri - File URI (string)
  • id - File ID (UUID string)
  • created_at - Creation timestamp (ISO 8601 string)
  • bytes - File size in bytes (number)

Supported Operators: • Equal - Exact match (requires valueText) • NotEqual - Not equal to value (requires valueText) • LessThan - Less than value (requires valueText) • GreaterThan - Greater than value (requires valueText) • Like - Case-insensitive pattern matching with wildcards (requires valueText) • In - Value is in array (requires valueTextArray) • ContainsAny - Array contains any of the values (requires valueTextArray) • ContainsAll - Array contains all of the values (requires valueTextArray)

Examples:

Metadata filtering:

{"metadata":[{"path":"speaker","operator":"Like","valueText":"YO%"}]}

Video info filtering (file-level):

{"video_info":[{"path":"duration_seconds","operator":"GreaterThan","valueText":"60"}]}

Video info filtering (segment-level):

{"video_info":[{"path":"duration_seconds","operator":"LessThan","valueText":"30","scope":"segment"}]}

File property filtering:

{"file":[{"path":"filename","operator":"Like","valueText":"%.mp4"}]}
{"file":[{"path":"bytes","operator":"GreaterThan","valueText":"1048576"}]}
{"file":[{"path":"created_at","operator":"GreaterThan","valueText":"2024-01-01T00:00:00Z"}]}

Combined filtering:

{"metadata":[{"path":"speaker","operator":"Equal","valueText":"John"}],"video_info":[{"path":"has_audio","operator":"Equal","valueText":"true"}],"file":[{"path":"filename","operator":"Like","valueText":"%.mp4"}]}

Response

A list of files in the collection

object'list' required

Object type, always 'list'

totalinteger required

Total number of files matching the query

limitinteger required

Number of items returned in this response

offsetinteger required

Offset from the start of the list

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status