Create Player

Designing

POST

/v1/libraries/{libraryId}/players

Create a player for your video, and customise it.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

🟠422Unprocessable Entity

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-staging.tenbyte.io/v1/v1/libraries/314221a1-3cbf-4d3c-846e-f6c22bc43064/players' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Default Player2",
    "language": "en",
    "font_family": "Rubik",
    "custom_html": "<!-- Custom analytics script -->",
    "playback_speeds": [
        0.5,
        1.0,
        1.5,
        2.0
    ],
    "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
    }
}'

Response Example

201 - Success

{
    "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
}

Modified at 2025-11-11 13:19:15

Delete Transcoding Profile

Player Details