ads

REST API for Your Streaming Platform

Drive catalogue, artwork, live channels, merchandising and reporting through a REST API that mirrors the admin area.

Create Your Free Account See Our Pricing
The Add New Video call in the platform API documentation on a laptop, with the same title open on a phone app

Artwork and Live Channels by API

Through the Vodlix API, artwork is attached by URL rather than uploaded by hand. One call sets a title's portrait, landscape and logo images, and another picks which generated frame serves as the thumbnail. Live channels are handled like videos: created from a stream URL, updated, published or unpublished, and trashed or restored, so linear content is automated the same way as on demand. For a large or frequently changing catalogue, that keeps artwork consistent without anyone uploading files one at a time.


API documentation for Update Content Thumbs, which sets a title's portrait, landscape and logo artwork from image URLs
REST API

Familiar and predictable.

Mirrors the admin

If you know the UI, you know the API.

Full lifecycle

Create, publish, unpublish, restore.

Manage the Catalogue Programmatically

The Vodlix REST API lets you drive the catalogue programmatically, mirroring the admin area. Videos can be created, updated, published or unpublished, and trashed or restored. Series and seasons are created, updated and published the same way, and episodes are attached to a season or detached from it. New video is ingested by giving the platform a file URL, public or in your own S3 or Wasabi storage: it fetches and processes the file in the background and returns a video ID to track it by. For OTT operators with existing systems, catalogue management can be automated rather than done by hand.


API documentation for Upload with URL, which ingests a video from a file URL on public, S3 or Wasabi storage
Storefront home page with Top 10 and Rent the Latest rows, the content lists an API call can switch on and off

Merchandising and Content Lists Under API Control

The Vodlix API gives you control over merchandising: content lists, list groups, their items and their ordering can all be created and managed programmatically. Lists can be activated and deactivated, so a seasonal row is switched off by API call rather than rebuilt. This allows scheduling systems and content planning tools to shape the home page automatically. Merchandising under API control is what lets editorial workflows scale.


Reference and Reporting Endpoints

The Vodlix API provides reference and reporting calls: category IDs, catalogue and user counts, a sales summary for any date range, and platform details such as the software version. Integrations always know what they are working against and can adapt to platform changes. Access runs on API keys created in the admin: a server key for back-end jobs, and a client key for browser code, which can never reach admin routes. The same calls are exposed to AI assistants through the platform's MCP connector.


MCP Access tools table listing platform info, content and user counts, catalogue browsing and a sales summary

Where It Usually Earns Its Keep

The common cases are migration, ingest and reporting. Moving a catalogue from another platform is an API job rather than a manual one, and it is the difference between a launch that waits on nobody and one measured in months. Recurring ingest from a distributor or a production workflow runs unattended once it is written. Reporting pulls figures into whatever your finance team already uses instead of asking somebody to export a screen every Monday.


It also joins your platform to the rest of your business. Push a new title into your CMS and your marketing site the moment it is published, or hand your content lists to a recommendation service and write the results back. Where an integration needs more than the API alone provides, our custom plugin service builds the missing piece against the same platform.


Analytics is available through the API where a stats service is configured on your cloud, which is worth confirming during setup rather than discovering later. The reports and analytics page covers what is measured.


Frequently Asked Questions

Have questions about taking advantage of this limited-time offer? Check out the FAQ for answers.

What can the Vodlix REST API control?
The Vodlix REST API controls the catalogue, including videos, series, seasons and episodes, plus artwork, live channels, content lists and merchandising, and reference and reporting data.
Do I upload video files through the Vodlix API?
New video is ingested through the Vodlix API by providing a public HTTPS URL. Vodlix fetches and transcodes the file, so you do not stream binary uploads through your own infrastructure.
Does the Vodlix API match the admin area?
Yes. The Vodlix REST API mirrors the admin area, with familiar REST conventions and predictable responses, so anyone who knows the UI knows roughly what the API can do.
Can I manage content lists through the Vodlix API?
Yes. Vodlix content lists, list groups, their items and ordering can all be created, updated, activated and deactivated through the API, so merchandising can be automated.
What reporting data does the Vodlix API provide?
The Vodlix API provides catalogue and user counts, a sales summary for a date range, category IDs and platform details such as the software version, so integrations always know what they are working against.
Are category ids the same across every Vodlix cloud?
No, and this is the most common thing to get wrong. Categories are per cloud, so read the category list for the platform you are working against and use the ids it returns rather than assuming a name maps to the same number everywhere.
Can we get analytics through the API?
Where a stats service is configured on your cloud, yes, covering headline figures, realtime activity and top performing content. It is worth confirming that during setup, because it is provisioned separately from the catalogue operations.
Is the API useful for migrating from another platform?
It is one of the most common reasons operators use it. Bringing a catalogue across programmatically turns a migration into a repeatable job rather than months of manual entry, and it can be run again to catch anything that changed while you were moving.
How do integrations authenticate with the Vodlix API?
With an API key created under Apps & APIs in the admin and sent in the X-Api-Key header. A server key acts with the permissions of the user it belongs to and can reach admin routes, so it belongs on a back end. A client key is safe for browser code and is blocked from every admin route. Keys can carry an expiry date, and deleting a key revokes it at once.