Create Player

Create Player

curl --request POST \
  --url https://api.tenbyte.io/v1/stream/libraries/{libraryId}/players \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Default Player2",
  "language": "en",
  "font_family": "Rubik",
  "custom_html": "<!-- Custom analytics script -->",
  "playback_speeds": [
    0.5,
    1,
    1.5,
    2
  ],
  "is_beta_enabled": true,
  "is_default": false,
  "enable_resumable_position": true,
  "vast_tag_url": "",
  "dynamic_watermark": {
    "enabled": true,
    "font_size": 16,
    "font_color": "#FFFFFF",
    "background_color": "#000000",
    "interval": 10
  },
  "analytics": {
    "facebook_pixel_id": null,
    "google_analytics_id": null
  },
  "appearance": {
    "primary_color": "#1D9BF0",
    "caption_font_color": "#FFFFFF",
    "caption_background_color": "#000000",
    "font_size": 16,
    "caption_font_size": 18,
    "logo": null,
    "logo_destination_url": null
  },
  "controls": {
    "loop": true,
    "backward": true,
    "forward": true,
    "big_play_button": true,
    "captions": true,
    "cast": false,
    "current_time": true,
    "duration": true,
    "fullscreen": true,
    "mute": true,
    "picture_in_picture": true,
    "play_pause": true,
    "progress": true,
    "settings": true,
    "volume": true,
    "controls_visible": true,
    "preload": true,
    "hide_branding": true,
    "enable_download_button": false
  }
}
'

{
  "data": {
    "created_at": "2025-10-19T20:00:43.475427+06:00",
    "updated_at": "2025-10-19T20:00:43.475427+06:00",
    "created_by": "ce877d84-c433-46fc-803d-ede73a8375bc",
    "updated_by": "ce877d84-c433-46fc-803d-ede73a8375bc",
    "font_family": "Rubik",
    "custom_html_footer": "<footer>Powered by MyApp</footer>",
    "name": "Default Player",
    "language": "en",
    "custom_html_head": "<!-- Custom analytics script -->",
    "playback_speeds": [
      0.5,
      1,
      1.5,
      2
    ],
    "appearance": {
      "primary_color": "#1D9BF0",
      "caption_font_color": "#FFFFFF",
      "caption_background_color": "#000000",
      "font_size": 16,
      "caption_font_size": 18
    },
    "library_id": "b17ccdc7-eb3d-4d03-b0af-781d3c38c7e9",
    "organization_id": "8babf060-e844-49e5-893c-35d0bf2edfc6",
    "id": "1aaff3a6-5d28-4be5-a503-eff1f33e7010",
    "controls": {
      "backward": true,
      "forward": true,
      "big_play_button": true,
      "captions": true,
      "current_time": true,
      "duration": true,
      "fullscreen": true,
      "mute": true,
      "picture_in_picture": true,
      "play_pause": true,
      "progress": true,
      "settings": true,
      "volume": true
    },
    "is_beta_enabled": true,
    "is_default": false,
    "enable_resumable_position": true
  },
  "message": "Player Created Successfully",
  "success": true
}

POST

libraries

{libraryId}

players

Create Player

curl --request POST \
  --url https://api.tenbyte.io/v1/stream/libraries/{libraryId}/players \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Default Player2",
  "language": "en",
  "font_family": "Rubik",
  "custom_html": "<!-- Custom analytics script -->",
  "playback_speeds": [
    0.5,
    1,
    1.5,
    2
  ],
  "is_beta_enabled": true,
  "is_default": false,
  "enable_resumable_position": true,
  "vast_tag_url": "",
  "dynamic_watermark": {
    "enabled": true,
    "font_size": 16,
    "font_color": "#FFFFFF",
    "background_color": "#000000",
    "interval": 10
  },
  "analytics": {
    "facebook_pixel_id": null,
    "google_analytics_id": null
  },
  "appearance": {
    "primary_color": "#1D9BF0",
    "caption_font_color": "#FFFFFF",
    "caption_background_color": "#000000",
    "font_size": 16,
    "caption_font_size": 18,
    "logo": null,
    "logo_destination_url": null
  },
  "controls": {
    "loop": true,
    "backward": true,
    "forward": true,
    "big_play_button": true,
    "captions": true,
    "cast": false,
    "current_time": true,
    "duration": true,
    "fullscreen": true,
    "mute": true,
    "picture_in_picture": true,
    "play_pause": true,
    "progress": true,
    "settings": true,
    "volume": true,
    "controls_visible": true,
    "preload": true,
    "hide_branding": true,
    "enable_download_button": false
  }
}
'

{
  "data": {
    "created_at": "2025-10-19T20:00:43.475427+06:00",
    "updated_at": "2025-10-19T20:00:43.475427+06:00",
    "created_by": "ce877d84-c433-46fc-803d-ede73a8375bc",
    "updated_by": "ce877d84-c433-46fc-803d-ede73a8375bc",
    "font_family": "Rubik",
    "custom_html_footer": "<footer>Powered by MyApp</footer>",
    "name": "Default Player",
    "language": "en",
    "custom_html_head": "<!-- Custom analytics script -->",
    "playback_speeds": [
      0.5,
      1,
      1.5,
      2
    ],
    "appearance": {
      "primary_color": "#1D9BF0",
      "caption_font_color": "#FFFFFF",
      "caption_background_color": "#000000",
      "font_size": 16,
      "caption_font_size": 18
    },
    "library_id": "b17ccdc7-eb3d-4d03-b0af-781d3c38c7e9",
    "organization_id": "8babf060-e844-49e5-893c-35d0bf2edfc6",
    "id": "1aaff3a6-5d28-4be5-a503-eff1f33e7010",
    "controls": {
      "backward": true,
      "forward": true,
      "big_play_button": true,
      "captions": true,
      "current_time": true,
      "duration": true,
      "fullscreen": true,
      "mute": true,
      "picture_in_picture": true,
      "play_pause": true,
      "progress": true,
      "settings": true,
      "volume": true
    },
    "is_beta_enabled": true,
    "is_default": false,
    "enable_resumable_position": true
  },
  "message": "Player Created Successfully",
  "success": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

libraryId

string

required

Unique identifier of the library.

Body

application/json

name

string

required

Name of the player configuration used to identify it within your account.

language

string

Default language code for interface text (e.g., en, es).

font_family

string

Font family used for player UI text.

custom_html

string

Custom HTML or script snippets to embed in the player.

playback_speeds

(number | integer)[]

List of playback speed options available to users (e.g., 0.5x, 1x, 1.5x, 2x).

is_beta_enabled

boolean

Enables experimental or beta player features for testing.

is_default

boolean

Marks this player configuration as the default for all videos.

enable_resumable_position

boolean

Allows viewers to resume playback from their last watched position.

vast_tag_url

boolean

VAST ad tag URL for video ad integration. Leave empty if ads are not used.

dynamic_watermark

object

Defines watermark display settings such as font, color, and movement interval.

Show child attributes

dynamic_watermark.enabled

boolean

Enables dynamic watermark display during playback.

dynamic_watermark.font_size

integer

Font size of the watermark text.

dynamic_watermark.font_color

string

Text color of the watermark in HEX format (e.g., #FFFFFF).

dynamic_watermark.background_color

string

Background color behind the watermark text.

dynamic_watermark.interval

integer

Interval in seconds for watermark position changes.

analytics

object

Contains analytics integration details for tracking player performance and engagement.

Show child attributes

analytics.facebook_pixel_id

string

Facebook Pixel ID for audience tracking and analytics.

analytics.google_analytics_id

string

Google Analytics ID for tracking player events.

appearance

object

Controls the visual appearance of the player including colors, fonts, and logo.

Show child attributes

appearance.primary_color

string

Primary color of the player interface (buttons, progress bar, etc.).

appearance.caption_font_color

string

Text color for captions.

appearance.caption_background_color

string

Background color for captions.

appearance.font_size

integer

Default font size for UI text.

appearance.caption_font_size

integer

Font size for caption text.

appearance.logo

string

URL of the logo displayed in the player (optional).

appearance.logo_destination_url

string

URL to open when the logo is clicked.

controls

object

Defines player control visibility and functionality, including playback, captions, and casting options.

Show child attributes

controls.loop

boolean

Enables loop playback mode for videos.

controls.backward

boolean

Enables the backward seek button.

controls.forward

boolean

Enables the forward seek button.

controls.big_play_button

boolean

Shows the central play button overlay before playback starts.

controls.captions

boolean

Enables the captions toggle button.

controls.cast

boolean

Enables Chromecast or casting options.

controls.current_time

boolean

Displays the current playback time.

controls.duration

boolean

Displays the total video duration.

controls.fullscreen

boolean

Enables fullscreen toggle option.

controls.mute

boolean

Enables the mute/unmute button.

controls.picture_in_picture

boolean

Allows Picture-in-Picture playback mode.

controls.play_pause

boolean

Enables play/pause button control.

controls.progress

boolean

Displays the progress bar for playback tracking.

controls.settings

boolean

Enables settings menu for resolution, captions, and speed options.

controls.volume

boolean

Enables volume control slider.

controls.controls_visible

boolean

Keeps playback controls visible at all times.

controls.preload_video_one_page_load

boolean

Preloads video data automatically when the page loads for faster playback start.

controls.hide_branding

boolean

Hides player branding or watermark.

controls.enable_download_button

boolean

Displays a download button to allow users to download the video.

controls.airplay

boolean

Enables AirPlay streaming for Apple devices.

controls.chromecast

boolean

Enables Chromecast support for casting playback to external devices.

Response

data

object

required

Show child attributes

data.created_at

string

required

data.updated_at

string

required

data.created_by

string

required

data.updated_by

string

required

data.font_family

string

required

data.custom_html_footer

string

required

data.name

string

required

data.language

string

required

data.custom_html_head

string

required

data.playback_speeds

(number | integer)[]

required

data.appearance

object

required

Show child attributes

data.appearance.primary_color

string

required

data.appearance.caption_font_color

string

required

data.appearance.caption_background_color

string

required

data.appearance.font_size

integer

required

data.appearance.caption_font_size

integer

required

data.library_id

string

required

data.organization_id

string

required

data.id

string

required

data.controls

object

required

Show child attributes

data.controls.backward

boolean

required

data.controls.forward

boolean

required

data.controls.big_play_button

boolean

required

data.controls.captions

boolean

required

data.controls.current_time

boolean

required

data.controls.duration

boolean

required

data.controls.fullscreen

boolean

required

data.controls.mute

boolean

required

data.controls.picture_in_picture

boolean

required

data.controls.play_pause

boolean

required

data.controls.progress

boolean

required

data.controls.settings

boolean

required

data.controls.volume

boolean

required

data.is_beta_enabled

boolean

required

data.is_default

boolean

required

data.enable_resumable_position

boolean

required

message

string

required

success

boolean

required

List Players Themes Player Details

⌘I

API documentation

CDN

Vidinfra

Authorizations

Path Parameters

Body

Response