We offer customization solutions and support ([email protected]) | Visit us on bitbyte3 for complete VOD solutions with apps.
NixStream
API Reference

Videos

List and retrieve videos via the Client API

List Videos

GET /videos

Returns a paginated list with filtering, sorting, and metadata.

Parameters

NameTypeRequiredDescription
pathstringNoFilter by collection path
filtersobjectNoMetadata field filters
tagsstringNoComma-separated tags
sortstringNoSort field (prefix - for descending)
per_pageintegerNoResults per page (1-100, default 15)

Sorting

Allowed sort columns: created_at, title, duration_in_seconds

sort=-created_at    # Newest first (default)
sort=title          # Alphabetical ascending
sort=-duration_in_seconds

Filtering examples

Filter by collection:

curl "https://your-domain.com/api/client/v1/videos?path=root/marketing" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filter by metadata (operators: eq, neq, gt, gte, lt, lte, in):

curl "https://your-domain.com/api/client/v1/videos?filters[category][eq]=Tutorial" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filter by tags:

curl "https://your-domain.com/api/client/v1/videos?tags=promo,featured" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sort by title ascending:

curl "https://your-domain.com/api/client/v1/videos?sort=title" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Paginated collection of video summaries with id, title, duration, thumbnail, metadata, and created_at.


Get Video

GET /videos/{videoId}

Returns full video details including manifest URLs, text tracks, thumbnails, and metadata.

Example request

curl "https://your-domain.com/api/client/v1/videos/{videoId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response includes

  • manifest: HLS/DASH playback URLs
  • text_tracks: Subtitle and caption tracks
  • thumbnail_images: Poster and thumbnail sprites
  • metadata: Custom metadata fields

Errors

StatusDescription
404Video not found or not in your tenant

On this page