Raw schema
{
"type": "object",
"properties": {
"folder_ref": {
"type": "string",
"description": "Folder name, ID, or dashboard URL"
},
"controls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of enabled player controls (incl. \"play-large\" = BotΓ£o de Play Grande). Values: \"play-large\", \"rewind\", \"play\", \"fast-forward\", \"progress\", \"current-time\", \"volume\", \"captions\", \"settings\", \"pip\", \"fullscreen\", \"airplay\", \"cast\""
},
"hideControlsOnStart": {
"type": "boolean",
"description": "Hide controls until user interacts"
},
"colors": {
"type": "object",
"properties": {
"primaryColor": {
"type": "string",
"description": "Primary accent color (hex)"
},
"controlsColor": {
"type": "string",
"description": "Controls color (hex)"
},
"background": {
"type": "string",
"description": "Player background color (hex)"
},
"captionsColor": {
"type": "string",
"description": "(Legacy) Subtitle text color (hex). Prefer `captions.foreground` on the modern subtitle editor."
},
"captionsBackgroundColor": {
"type": "string",
"description": "(Legacy) Subtitle background color (hex). Prefer `captions.background`."
}
},
"additionalProperties": false,
"description": "Player color settings"
},
"captions": {
"type": "object",
"properties": {
"foreground": {
"type": "string",
"description": "Subtitle text color as 8-char hex with alpha β `RRGGBBAA`, e.g. 'FFFFFFFF' = opaque white."
},
"background": {
"type": "string",
"description": "Subtitle background color as 8-char hex with alpha β `RRGGBBAA`, e.g. '000000B3' = 70% opaque black."
}
},
"additionalProperties": false,
"description": "Per-video subtitle (caption) appearance β text and background colors (v2 dashboard)."
},
"vsl": {
"type": "object",
"properties": {
"autoplay": {
"type": "boolean",
"description": "Auto-play video"
},
"smartAutoplay": {
"type": "boolean",
"description": "Smart Autoplay β auto-plays muted, unmutes on interaction"
},
"disablePause": {
"type": "boolean",
"description": "Disable pause button (VSL mode)"
},
"disableForward": {
"type": "boolean",
"description": "Disable forward/seek (VSL mode)"
},
"restartAfterEnd": {
"type": "boolean",
"description": "Restart video after it ends"
},
"alternativeProgress": {
"type": "boolean",
"description": "Fake progress bar (VSL mode)"
},
"alternativeProgressHeight": {
"type": "number",
"description": "Fake progress bar height in px"
},
"alternativeProgressVelocity": {
"type": "number",
"description": "Fake progress bar speed (1-10)"
},
"alternativeProgress2xLimit": {
"type": "number",
"description": "Percentage at which fake progress accelerates"
},
"alternativeProgressDefaultVelocity": {
"type": "boolean",
"description": "Use recommended fake progress speed"
},
"timeDisplayType": {
"type": "string",
"enum": [
"CURRENT_TIME",
"REMAINING_TIME"
],
"description": "Time display format"
},
"defaultLanguage": {
"type": "string",
"description": "Default subtitle language"
},
"mutedIndicatorIcon": {
"type": "boolean",
"description": "Show muted indicator overlay"
},
"mutedIndicatorSize": {
"type": "string",
"enum": [
"none",
"small",
"medium",
"large"
],
"description": "Muted indicator size"
},
"mutedIndicatorFontSize": {
"type": "number",
"description": "Muted indicator font size (12-32)"
},
"mutedIndicatorTextTop": {
"type": "string",
"description": "Muted indicator top text (max 40 chars)"
},
"mutedIndicatorTextBottom": {
"type": "string",
"description": "Muted indicator bottom text (max 40 chars)"
},
"mutedIndicatorBackgroundColor": {
"type": "string",
"description": "Muted indicator background color"
},
"mutedIndicatorTextColor": {
"type": "string",
"description": "Muted indicator text color"
},
"mutedIndicatorAnimation": {
"type": "string",
"description": "Muted indicator animation style"
},
"pandaBranding": {
"type": "boolean",
"description": "Show Panda branding in player"
},
"refCode": {
"type": "string",
"description": "Affiliate referral code"
}
},
"additionalProperties": false,
"description": "VSL (Video Sales Letter) settings β controls autoplay, smart autoplay, fake progress bar, muted indicator"
},
"saveProgress": {
"type": "object",
"properties": {
"saveProgress": {
"type": "boolean",
"description": "Enable resume from last position"
},
"initQuality": {
"type": "number",
"description": "Initial video quality (e.g. 720)"
},
"saveProgressScreen": {
"type": "boolean",
"description": "Show resume screen"
},
"saveProgressTitle": {
"type": "string",
"description": "Resume screen title"
}
},
"additionalProperties": false,
"description": "Save progress / resume settings"
},
"general": {
"type": "object",
"properties": {
"default_speed": {
"type": "number",
"description": "Default playback speed (1, 1.1, 1.2, 1.3, 1.4, 1.5)"
},
"smartSearch": {
"type": "boolean",
"description": "(Legacy) Enable smart search in video. v2 sends `searchInsideVideo` β both accepted."
},
"fontSize": {
"type": "string",
"enum": [
"extraSmall",
"small",
"normal",
"large",
"extraLarge"
],
"description": "Subtitle font size keyword: extraSmall=10px, small=12px, normal=14px(default), large=16px, extraLarge=18px. Send fontSizePx alongside."
},
"fontSizePx": {
"type": "number",
"description": "Subtitle font size in px β must match fontSize: 10/12/14/16/18."
},
"startsWithSubtitle": {
"type": "boolean",
"description": "Whether the video starts with the subtitle track visible by default."
},
"searchInsideVideo": {
"type": "boolean",
"description": "Enable smart search inside the video (same semantic as legacy smartSearch)."
}
},
"additionalProperties": false,
"description": "General player + subtitle settings (speed, font size, search-in-video, defaults)."
},
"dry_run": {
"type": "boolean",
"default": true,
"description": "true = validate + preview only; false = apply"
},
"idempotency_key": {
"type": "string",
"description": "Reserved client-supplied retry key"
}
},
"required": [
"folder_ref"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}