Download OpenAPI specification:Download
The Freecaster API gives users total control over the Freecaster video platform and allows them to seamlessly integrate it into their workflows.
Based on the JSON:API specifications, the API provides access to all features and functionality of the platform, including the ability to manage video content and metadata, control player settings, etc.
With the Freecaster API, users can automate tasks and easily integrate the platform with other tools and services. Whether you need to make small adjustments or large-scale changes, the Freecaster API puts the power in your hands to customize and optimize the platform for your specific needs.
⚠️ The API and its documentation are work in progress and subject to change.
Generate a JWT token used to access the API calls
client_id required | string <uuid> |
client_secret required | string |
scope | string |
token_type | string Value: "Bearer" |
expires_in | integer Token expiration (in seconds) |
access_token | string |
{- "client_id": "95c9558d-ca6f-45bc-8de6-37c5349282e0",
- "client_secret": "xMeKLww9pX7ZsYqeEIXr9LljybpMEpDX6QPsAh4S",
- "scope": "roles"
}
{- "token_type": "Bearer",
- "expires_in": 1296000,
- "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5NWUxYTgzZC0wYjU3LTQ4NjktYmQ2ZS03YzZjNzMzYTg2MjEiLCJqdGkiOiJkYzc0NWFhZGEzNTdlZmNmMmZkYzJhZTFjY2FiMjcyOGYwMmMzMWJjMTViMzA5YTYwMjZlODkyYWUyMDQ0YmUzMGVlZTZiMmU3OGM3OTNmMCIsImlhdCI6MTY0OTIzOTQ2NS4xODg0OSwibmJmIjoxNjQ5MjM5NDY1LjE4ODQ5NSwiZXhwIjoxNjUwNTM1NDY1LjE0OTEzOCwic3ViIjoiIiwic2NvcGVzIjpbIioiXSwibmFtZSI6Ik5ldyBhZG1pbiIsImVtYWlsIjoiZGV2K3RlbmFudEBmcmVlY2FzdGVyLmNvbSIsInRlbmFudCI6ImNsaWVudC1uYW1lIn0.amAsTy8Cjwr_Fu_gqLeHhgRsTtBS4FZDDIPp_zzkF-3Ofv92YBUr02svXvZpyYQ_rfe4IsKEGhsJr7gQvrR0AUz7QQUORUG_J45LTCIsab0nh_Gz_8KBrYrsn0RZGcVqOf8A_TGFAlVQt26Pz5FQmFFBPvwPinx6qjqXnSx5xzS8YtAp5ksME7cUErdngALrLdWvbdZTcEHaFFKoqZt0vc-_S6vXh7A5OfZ1sY1vqDKxGalvFxQ1hm66_SDzDNAYNEq6RQrDes0cRReIbR8W7wEy7kEOzryiOoO0Yfl7UJCPFgKlTquY9afvfUTRlned78n8h_jaohC1K59TNgo8GRoDS_Ad_ouZDGfEsOhvlTIe0Vhw88IN6EULceKsm2HWE7DgSjw2C9MA7TLckQMTN2QDjxqrLuGu6eekHB_VqIrvgAh9Kg3bRCNeK7yRzQlG8h-qJ88BdRTMno9I8z9Pw_YkxwdC0ih6NAUGcmRI4nRlC1nYXr0bntTOwX2IfKhZWw7Hmrck-6j5uF5yYb0pQF7V11AbdrZ4Iw6TIELCvWLmIbQ81Wpc3B6XTt8L74mxDSurOmv87Sc-pdzLwtNcSKfQlfIfsfJhb6IQRwB8HsjDQM47Jy-mvTcGqxq6vu6OKwNjR5UFqrxEQAt56TaxM3iZ5UcMUW_qNu6QhO1rLBU"
}
Generate a signed URL to upload a video to the ingest S3 bucket.
The upload must be done as a PUT request with the video file as body (see the AWS documentation for more information).
After the upload has completed, your file will be transcoded. Once the transcoding has finished or has failed, you will receive a callback through the registered webhooks.
required | object | ||||||||||||||||
| |||||||||||||||||
object (request-meta) | |||||||||||||||||
|
object (s3upload-jsonapi) | |||||||||
|
{- "data": {
- "type": "s3upload",
- "attributes": {
- "filename": "myvideo.mp4"
}
}
}
{- "data": {
- "data": {
- "type": "s3upload",
- "attributes": {
- "video": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
}
}
}
Generate an array of signed URLs to upload a video to the ingest S3 bucket.
required | object | ||||||||||||||||
| |||||||||||||||||
object (request-meta) | |||||||||||||||||
|
object (s3upload-multipart-jsonapi) | |||||||||
|
{- "data": {
- "type": "s3upload",
- "attributes": {
- "filename": "myvideo.mp4"
}
}
}
{- "data": {
- "data": {
- "type": "s3upload",
- "attributes": {
- "uploads": [
- {
- "upload_id": "string",
- "key": "string",
- "urls": [
- "string"
]
}
], - "video": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
}
}
}
Complete the multipart upload and reassemble all the parts.
object | |||||||||||
|
{- "data": {
- "type": "s3uploadComplete",
- "attributes": {
- "upload_id": "string",
- "key": "string"
}
}
}
{- "errors": [
- {
- "status": 401,
- "title": "Unauthenticated",
- "detail": "Unauthenticated",
- "meta": { }
}
]
}
List all videos
filter[published] | boolean Default: true Example: filter[published]=false Show only published ( |
filter[live] | boolean Example: filter[live]=true Show only live ( |
sort | string Default: "-published_at" Example: sort=title Sort results by the given attribute |
page[number] | integer Default: "0" Example: page[number]=1 Page number |
page[size] | integer Default: "15" Example: page[size]=50 Page size |
include | string Example: include=parents,poster Comma-separated list of relationships to include in the response |
Array of objects (video-jsonapi) | |||||||
Array
|
{- "data": [
- {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
]
}
Create a new video
object | |||||||||||||||||||||||||||
|
object (video-jsonapi) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "video",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "published": true
}
}
}
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
}
Get a video
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
include | string Example: include=parents,poster Comma-separated list of relationships to include in the response |
object (video-jsonapi) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (video-meta) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}, - "meta": {
- "duration": 10.5,
- "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}, - "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}
}
}
Edit a video
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
object (video-jsonapi) | |||||||||||||||||||||||||||||
|
object (video-jsonapi) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (video-meta) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
}
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}, - "meta": {
- "duration": 10.5,
- "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}, - "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}
}
}
Delete a video
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
{- "errors": [
- {
- "status": 401,
- "title": "Unauthenticated",
- "detail": "Unauthenticated",
- "meta": { }
}
]
}
Get the active poster of a video
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
object (poster-jsonapi) | |||||||||||||||||
| |||||||||||||||||
object (poster-meta) | |||||||||||||||||
|
{- "data": {
- "type": "poster",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "locale": "en-GB",
- "is_active": true
}
},
}
Create and associate a poster to a video. There are two ways to attach a poster, either through an image upload or through extraction from the video given a timestamp.
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
poster | file Binary upload data |
object (poster-jsonapi) | |||||||||||||||||
| |||||||||||||||||
object (poster-meta) | |||||||||||||||||
|
{- "data": {
- "type": "poster",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "locale": "en-GB",
- "is_active": true
}
},
}
Get all posters from a video
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
Array of objects (poster-jsonapi) | |||||||
Array
|
{- "data": [
- {
- "type": "poster",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "locale": "en-GB",
- "is_active": true
}
}
]
}
Create and transcode a video
object | |||||||||||||||||||||||||||||
|
object (video-jsonapi) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "video",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "input_files": [
- "path/to/video_file.mp4"
]
}
}
}
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
}
List all versions
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
filter[locale] | string Example: filter[locale]=eng-gb Show only versions matching the given locale |
page[number] | integer Default: "0" Example: page[number]=1 Page number |
page[size] | integer Default: "15" Example: page[size]=50 Page size |
Array of objects | |||||||||
Array
|
{- "data": [
- {
- "type": "version",
- "id": "3243cb0a-9ede-4839-9a2c-4ec3bc1cc506",
- "attributes": {
- "name": "default",
- "type": "vod",
- "is_active": true,
- "duration": 300.5,
- "start_offset": [
- 307373100000,
- 1668782233000
], - "end_offset": [
- 307373100000,
- 1668782233000
], - "meta": { }
}, - "meta": {
- "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}, - "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}
}
}
]
}
Get version
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
versionUuid required | string <uuid> Example: 3243cb0a-9ede-4839-9a2c-4ec3bc1cc506 UUID of the version |
object (version-jsonapi) | |||||||||||||||||||||||
| |||||||||||||||||||||||
object (version-meta) | |||||||||||||||||||||||
|
{- "data": {
- "type": "version",
- "id": "3243cb0a-9ede-4839-9a2c-4ec3bc1cc506",
- "attributes": {
- "name": "default",
- "type": "vod",
- "is_active": true,
- "duration": 300.5,
- "start_offset": [
- 307373100000,
- 1668782233000
], - "end_offset": [
- 307373100000,
- 1668782233000
], - "meta": { }
}
}, - "meta": {
- "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}, - "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}
}
}
Edit a version
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
versionUuid required | string <uuid> Example: 3243cb0a-9ede-4839-9a2c-4ec3bc1cc506 UUID of the version |
object (version-jsonapi) | |||||||||||||||||||||||
|
object (version-jsonapi) | |||||||||||||||||||||||
| |||||||||||||||||||||||
object (version-meta) | |||||||||||||||||||||||
|
{- "data": {
- "type": "version",
- "id": "3243cb0a-9ede-4839-9a2c-4ec3bc1cc506",
- "attributes": {
- "name": "default",
- "type": "vod",
- "is_active": true,
- "duration": 300.5,
- "start_offset": [
- 307373100000,
- 1668782233000
], - "end_offset": [
- 307373100000,
- 1668782233000
], - "meta": { }
}
}
}
{- "data": {
- "type": "version",
- "id": "3243cb0a-9ede-4839-9a2c-4ec3bc1cc506",
- "attributes": {
- "name": "default",
- "type": "vod",
- "is_active": true,
- "duration": 300.5,
- "start_offset": [
- 307373100000,
- 1668782233000
], - "end_offset": [
- 307373100000,
- 1668782233000
], - "meta": { }
}
}, - "meta": {
- "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}, - "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}
}
}
Delete version
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
versionUuid required | string <uuid> Example: 3243cb0a-9ede-4839-9a2c-4ec3bc1cc506 UUID of the version |
{- "errors": [
- {
- "status": 401,
- "title": "Unauthenticated",
- "detail": "Unauthenticated",
- "meta": { }
}
]
}
Activate a version
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
versionUuid required | string <uuid> Example: 3243cb0a-9ede-4839-9a2c-4ec3bc1cc506 UUID of the version |
object (version-jsonapi) | |||||||||||||||||||||||
| |||||||||||||||||||||||
object (version-meta) | |||||||||||||||||||||||
|
{- "data": {
- "type": "version",
- "id": "3243cb0a-9ede-4839-9a2c-4ec3bc1cc506",
- "attributes": {
- "name": "default",
- "type": "vod",
- "is_active": true,
- "duration": 300.5,
- "start_offset": [
- 307373100000,
- 1668782233000
], - "end_offset": [
- 307373100000,
- 1668782233000
], - "meta": { }
}
}, - "meta": {
- "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}, - "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}
}
}
Create a live event
object | |||||||||||||||||||||||||||||||||||||
|
object (video-jsonapi) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (video-meta) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "live",
- "attributes": {
- "title": "string",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z",
- "archive_size": 3600,
- "dvr_window": 60,
- "archiving": true,
- "delivery_filters": {
- "max_width": 1280
}, - "rtmp_ingest": false
}
}
}
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}, - "meta": {
- "duration": 10.5,
- "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}, - "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}
}
}
Update a live event
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
object | |||||||||||||||||||||||||||||||||||
|
object (video-jsonapi) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (video-meta) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "live",
- "attributes": {
- "title": "string",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z",
- "archive_size": 3600,
- "dvr_window": 60,
- "archiving": true,
- "delivery_filters": {
- "max_width": 1280
}
}
}
}
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}, - "meta": {
- "duration": 10.5,
- "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}, - "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}
}
}
Deactivate the waiting screen in the player and start playing the live stream
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
object (video-jsonapi) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (video-meta) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}, - "meta": {
- "duration": 10.5,
- "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}, - "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}
}
}
Stop playing the live stream in the player and show the end screen
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
object (video-jsonapi) | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
object (video-meta) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}, - "meta": {
- "duration": 10.5,
- "delivery_urls": {
- "progressive": [
- {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 256,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 512,
- "height": 288
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 520,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "baseline",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 640,
- "height": 360
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 96,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 1200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "main",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 854,
- "height": 480
}, - {
- "type": "audio",
- "default": null,
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "sample_format": null,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 2600,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1280,
- "height": 720
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}, - {
- "tracks": [
- {
- "type": "video",
- "codec": "h264",
- "bitrate": 5200,
- "duration": 12.3,
- "metadata": [ ],
- "profile": "high",
- "pixel_format": "yuv420p",
- "fps": 25,
- "gop_size": 50,
- "frames": 308,
- "width": 1920,
- "height": 1080
}, - {
- "type": "audio",
- "language": "eng",
- "codec": "aac",
- "bitrate": 128,
- "duration": 12.3,
- "metadata": [ ],
- "sample_rate": 48000,
- "channels": 2,
- "channel_layout": "stereo"
}
]
}
],
}, - "ingest_urls": {
- "rtmp": [
- {
- "url": "rtmp://example.com/live/bff30c1f-4320-4891-a8d2-3ac4cbc22fba"
}
]
}
}
}
Create a clip from a video
If you specify a slug that is already used by an existing video, it will create a new version of that video (and update its title if specified in the attributes).
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
object | |||||||||||||||||||
| |||||||||||||||||||
object (request-meta) | |||||||||||||||||||
|
object (video-jsonapi) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "clip",
- "attributes": {
- "start": 1654086896,
- "end": 1654088194
}
}, - "meta": {
- "custom_ref": "my-reference"
}
}
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
}
Create a clip from a video as a new version of an existing clip.
The clip title can be updated if specified in the attributes.
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
clipUuid required | string <uuid> Example: 453fc82b-3508-4efa-8267-a159035dc20b UUID of the existing clip |
object | |||||||||||||||||||
| |||||||||||||||||||
object (request-meta) | |||||||||||||||||||
|
object (video-jsonapi) | |||||||||||||||||||||||||||||
|
{- "data": {
- "type": "clip",
- "attributes": {
- "start": 1654086896,
- "end": 1654088194
}
}, - "meta": {
- "custom_ref": "my-reference"
}
}
{- "data": {
- "type": "video",
- "id": "d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6",
- "attributes": {
- "title": "My Video Title",
- "description": "This is the description of my video",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-video",
- "live": false,
- "countdown_time": "2030-09-28T14:15:00Z"
}
}
}
List all chapters
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
sort | string Default: "-published_at" Example: sort=title Sort results by the given attribute |
page[number] | integer Default: "0" Example: page[number]=1 Page number |
page[size] | integer Default: "15" Example: page[size]=50 Page size |
Array of objects (chapter-jsonapi) | |||||||
Array
|
{- "data": [
- {
- "type": "chapter",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "title": "My Chapter Title",
- "description": "This is a chapter with relative timestamps",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-chapter",
- "start": 10000,
- "end": 20000,
- "is_clip": true
}
}
]
}
Create a new chapter
object | |||||||||||||||||||||||||||||
|
object (chapter-jsonapi) | |||||||||||||||||||||||||||||||
|
{- "data": {
- "type": "chapter",
- "attributes": {
- "title": "My Chapter Title",
- "description": "This is a chapter with relative timestamps",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-chapter",
- "start": 10000,
- "end": 20000,
- "is_clip": true
}
}
}
{- "data": {
- "type": "chapter",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "title": "My Chapter Title",
- "description": "This is a chapter with relative timestamps",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-chapter",
- "start": 10000,
- "end": 20000,
- "is_clip": true
}
}
}
Get a chapter
chapterUuid required | string <uuid> Example: 94b93ff9-a30e-4ed7-8679-5526d0e1b8db UUID of the chapter |
include | string Example: include=parents,poster Comma-separated list of relationships to include in the response |
object (chapter-jsonapi) | |||||||||||||||||||||||||||||||
|
{- "data": {
- "type": "chapter",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "title": "My Chapter Title",
- "description": "This is a chapter with relative timestamps",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-chapter",
- "start": 10000,
- "end": 20000,
- "is_clip": true
}
}
}
Edit a chapter
chapterUuid required | string <uuid> Example: 94b93ff9-a30e-4ed7-8679-5526d0e1b8db UUID of the chapter |
object (chapter-jsonapi) | |||||||||||||||||||||||||||||||
|
object (chapter-jsonapi) | |||||||||||||||||||||||||||||||
|
{- "data": {
- "type": "chapter",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "title": "My Chapter Title",
- "description": "This is a chapter with relative timestamps",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-chapter",
- "start": 10000,
- "end": 20000,
- "is_clip": true
}
}
}
{- "data": {
- "type": "chapter",
- "id": "94b93ff9-a30e-4ed7-8679-5526d0e1b8db",
- "attributes": {
- "title": "My Chapter Title",
- "description": "This is a chapter with relative timestamps",
- "created_at": "2021-09-28T14:15:00Z",
- "updated_at": "2021-09-28T14:15:00Z",
- "published": true,
- "published_at": "2021-09-28T14:15:00Z",
- "unpublished_at": "2021-09-28T14:15:00Z",
- "slug": "my-chapter",
- "start": 10000,
- "end": 20000,
- "is_clip": true
}
}
}
Delete a chapter
chapterUuid required | string <uuid> Example: 94b93ff9-a30e-4ed7-8679-5526d0e1b8db UUID of the chapter |
{- "errors": [
- {
- "status": 401,
- "title": "Unauthenticated",
- "detail": "Unauthenticated",
- "meta": { }
}
]
}
List all subtitles
videoUuid required | string <uuid> Example: d0ec9b9a-a05f-48b3-bfb4-bad9634ed2f6 UUID of the video |
filter[locale] | string Example: filter[locale]=eng-gb Show only subtitles matching the given locale |
page[number] | integer Default: "0" Example: page[number]=1 Page number |
page[size] | integer Default: "15" Example: page[size]=50 Page size |
Array of objects | |||||||||
Array
|
{- "data": [
- {
- "type": "subtitle",
- "id": "6462bcb1-ce61-4061-8f43-176694a1e9c5",
- "attributes": {
- "name": "English",
- "locale": "eng-gb"
}, - "meta": {
}
}
]
}