Flowplayer OVP API v3 (3.0.0)

Download OpenAPI specification:Download

Introduction

This API allows integration of your backend (like content management or publishing systems) with the Flowplayer platform for managing video and livestream assets. It can be used to fetch, list, create, update and delete Livestreams, Live Sources, Playlists, Categories and Videos.

Authentication

All API requests need to be authenticated by providing the API keys as an header, x-flowplayer-api-key.

apiKey

Security Scheme Type API Key
Header parameter name: x-flowplayer-api-key

Rate limits

Every API request has a rate limit, applied per the organization the x-flowplayer-api-key is part of. This means that for the same organization there is a limited number of requests per second that can be done. By default, every organization can perform 1 request/second of every API. Enterprise organizations can do up to 3 requests/second of every API.

If your organization triggers this rate limit, you'll receive the response status code 429 - Too Many Requests with a response body { "message" : "Too Many Requests"}.

Requesting the API

Base url for the API is:

https://api.flowplayer.com/platform/v3/

Endpoint structure

Each asset type has its own path and endpoint in the API with the following structure:

Asset type Path
Livestreams /livestreams
Live Sources /livesources
Playlists /playlists
Category /categories
Video /videos

Content type

This API only supports JSON-format output.

Sample request

A sample request for listing livestreams using the API.

 curl https://api.flowplayer.com/platform/v3/livestreams \
 -H "x-flowplayer-api-key: {my-api-key}" \
 -H "Content-Type: application/json"

Category

Categories can be used to categorize videos and livestreams within a workspace and are useful for creating automatic playlists and recommendations.

Categories are organized as a hierarchical tree structure. A video/livestream belongs to one single category.

List Category

Endpoint for listing a Category

Authorizations:
query Parameters
workspace_id
string
page
integer <int32>
Default: 0

Page number

page_size
integer <int32>
Default: 20

Page size

q
string

Searches text fields case insensitive and partial (don't require full matches).

For Categories, name and description are the only searchable fields.

Limit to a specific field with a colon (:).

If you have multiple search terms you can use pipe (|) to separate the search terms.

Examples:

Query Description
q=foo Searches name & description field for foo.
q=foo:description Searches description field for foo.
q=foo|bar Searches name for foo and bar. A Category must match both to be included.
sort_by
string
Default: "name"
Value: "name"
sort_order
any
Default: "DESC"
Enum: "DESC" "ASC"
Example: sort_order=ASC

The sort order of the response

only_top_level
boolean
Default: false