Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID of the collection
Query Parameters
Maximum number of files to return
x <= 100
Number of files to skip
Filter by processing status
pending
, processing
, completed
, failed
, not_applicable
Filter files added before a specific date (YYYY-MM-DD format), in UTC timezone
Filter files added after a specific date (YYYY-MM-DD format), in UTC timezone
Order the files by a specific field
added_at
, filename
Sort the files in ascending or descending order
asc
, desc
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., 'speaker', 'category.subcategory') • video_info - Filter by video information properties
duration_seconds
- Video duration in secondshas_audio
- Whether the video has audio (true/false)
• 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:
{"video_info":[{"path":"duration_seconds","operator":"GreaterThan","valueText":"60"}]}
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 type, always 'list'
list
Array of collection file objects
Total number of files matching the query
Number of items returned in this response
Offset from the start of the list