Wistia Customizations API
The Customizations API from Wistia — 1 operation(s) for customizations.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/wistia-customizations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Wistia Customizations API
version: '1.0'
description: 'Operations tagged Customizations across 4 of this provider''s published API definitions: wistia-customizations-api-openapi.yml, wistia-data-api-2026-01-openapi.yml, wistia-data-api-modern-edge-openapi.yml, wistia-data-api-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.wistia.com/v1
description: Wistia Data API production server
- url: https://api.wistia.com/modern
tags:
- name: Customizations
paths:
/medias/{hashedId}/customizations:
parameters:
- in: path
name: hashedId
required: true
schema:
type: string
get:
tags:
- Customizations
summary: Show customizations
operationId: getCustomizations
responses:
'200':
description: OK
security:
- bearerAuth: []
- basicAuth: []
post:
tags:
- Customizations
summary: Create customizations
operationId: createCustomizations
responses:
'201':
description: Created
security:
- bearerAuth: []
- basicAuth: []
put:
tags:
- Customizations
summary: Update customizations
operationId: updateCustomizations
responses:
'200':
description: OK
security:
- bearerAuth: []
- basicAuth: []
delete:
tags:
- Customizations
summary: Delete customizations
operationId: deleteCustomizations
responses:
'204':
description: No Content
security:
- bearerAuth: []
- basicAuth: []
servers:
- url: https://api.wistia.com/v1
description: Wistia Data API production server
/medias/{mediaId}/customizations:
get:
x-wistia-mcp-ignore: true
summary: Show Customizations
description: 'Fetches explicitly defined customizations for the video.
<!--- HIDE-MCP -->
## Requires api token with one of the following permissions
```
Read all folder and media data
```
<!--- /HIDE-MCP -->
'
parameters:
- name: mediaId
in: path
description: The hashed ID of the video.
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
unevaluatedProperties: false
type: object
properties:
playerColor:
description: The color of the video player.
type: string
stillUrl:
type: string
autoPlay:
description: Whether the video should auto play or not.
type: string
bpbTime:
type: string
controlsVisibleOnLoad:
type: string
endVideoBehavior:
description: Behavior of the video at the end.
type: string
fullscreenButton:
type: string
branding:
type: string
playbar:
type: string
playButton:
description: Indicates if the play button is visible.
type: string
settingsControl:
type: string
showCustomerLogo:
type: string
qualityControl:
type: string
playbackRateControl:
type: string
smallPlayButton:
type: string
spherical:
type: string
volumeControl:
type: string
copyLinkAndThumbnailEnabled:
type: string
doNotTrack:
type: string
email:
type: string
fitStrategy:
type: string
fullscreenOnRotateToLandscape:
type: string
muted:
type: string
playlistLinks:
type: string
playlistLoop:
type: string
playsinline:
type: string
playPauseNotifier:
type: string
playSuspendedOffScreen:
type: string
preload:
type: string
qualityMax:
type: string
qualityMin:
type: string
resumable:
type: string
seo:
type: string
silentAutoPlay:
type: string
time:
type: string
thumbnailAltText:
type: string
videoFoam:
type: string
volume:
type: string
wmode:
type: string
keyMoments:
description: String representation of whether the key moments feature is enabled.
type: string
plugin:
unevaluatedProperties: true
type: object
properties:
passwordProtectedVideo:
unevaluatedProperties: false
type: object
properties:
'on':
type: string
src:
type: string
challenge:
type: string
async:
type: string
videoThumbnail:
unevaluatedProperties: false
type: object
properties:
clickToPlayButton:
type: string
socialbar-v1:
unevaluatedProperties: false
type: object
properties:
buttons:
type: string
showTweetCount:
type: string
tweetText:
type: string
height:
type: string
chapters:
unevaluatedProperties: false
type: object
properties:
visibleOnLoad:
type: string
chapterList:
type: array
items:
unevaluatedProperties: false
type: object
properties:
id:
type: string
title:
type: string
time:
type: string
deleted:
type: string
'on':
type: string
postRoll-v1:
unevaluatedProperties: false
description: Adds a Call To Action to your Video (response format)
type: object
properties:
rewatch:
description: String representation of whether the video can be rewatched.
type: string
text:
description: The URL of the text to be displayed.
type: string
link:
description: The URL of the link to be displayed.
type: string
time:
description: The time when the post-roll should be displayed as a string.
type: string
autoSize:
description: String representation of whether the post-roll will automatically adjust its size.
type: string
style:
unevaluatedProperties: false
type: object
properties:
backgroundColor:
description: The background color of the post-roll.
type: string
ctaType:
description: The type of call-to-action to be displayed.
type: string
'on':
description: String representation of whether the post-roll is enabled.
type: string
conversionOpportunityKey:
description: The key used for tracking conversion opportunities.
type: string
captions-v1:
unevaluatedProperties: false
description: Captions plugin configuration (response format)
type: object
properties:
'on':
description: String representation of whether the captions plugin is enabled ("true" or "false").
type: string
onByDefault:
description: String representation of whether captions are turned on by default ("true" or "false").
type: string
private:
unevaluatedProperties: false
type: object
properties:
password_protect_on:
type: string
show_comments:
type: string
encrypted:
unevaluatedProperties: false
type: object
properties:
password_protect_password:
type: string
'401':
description: Unauthorized, invalid or missing token
content:
application/json:
schema:
unevaluatedProperties: false
type: object
properties:
code:
description: A machine-readable identifier for the specific authorization failure.
type: string
enum:
- unauthorized_credentials
- account_inactive
- unauthorized_scope
- unauthorized_params
error:
type: string
examples:
- Invalid credentials.
'404':
description: Resource not found
content:
application/json:
schema:
unevaluatedProperties: false
type: object
properties:
error:
type: string
examples:
- Folder with ID 'fakeid' not found.
'500':
description: Internal server error
content:
application/json:
schema:
unevaluatedProperties: false
type: object
properties:
error:
type: string
examples:
- Internal server error
tags:
- Customizations
security:
- BearerAuth: []
post:
x-wistia-mcp-ignore: true
summary: Create Customizations
description: 'Set customizations for a video. Replaces the customizations explicitly set for this video.
<!--- HIDE-MCP -->
## Requires api token with one of the following permissions
```
Read, update & delete anything
```
<!--- /HIDE-MCP -->
'
parameters:
- name: mediaId
in: path
description: The hashed ID of the video.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
unevaluatedProperties: false
type: object
description: 'A collection of settings you can apply to a video to change its appearance and
behavior.
'
properties:
autoPlay:
description: If set to true, the video will play as soon as it’s ready. Note that autoplay might not work on some devices and browsers.
type: boolean
controlsVisibleOnLoad:
description: If set to true, controls like the big play button, playbar, volume, etc. will be visible as soon as the video is embedded.
type: boolean
copyLinkAndThumbnailEnabled:
description: If set to false, the option to “Copy Link and Thumbnail” will be removed when right-clicking on the video.
type: boolean
doNotTrack:
description: If set to true, data for each viewing session will not be tracked.
type: boolean
email:
description: Associate a specific email address with this video’s viewing sessions.
type: string
endVideoBehavior:
description: Determines what happens when the video ends. Options are default (stays on the last frame), reset (shows thumbnail and controls), and loop (plays again from the start).
type: string
fakeFullscreen:
description: If set to true, the video will try to play in a pseudo-fullscreen mode on certain mobile devices.
type: boolean
fitStrategy:
description: Resizes the video when there's a discrepancy between its aspect ratio and that of its parent container. Options are contain, cover, fill, and none.
type: string
fullscreenButton:
description: If set to true, the fullscreen button will be available as a video control.
type: boolean
fullscreenOnRotateToLandscape:
description: If set to false, the video will not automatically go to fullscreen mode on mobile when rotated to landscape.
type: boolean
keyMoments:
description: If set to false, the key moments feature will be disabled.
type: boolean
muted:
description: If set to true, the video will start in a muted state.
type: boolean
playbackRateControl:
description: If set to false, the playback speed controls in the settings menu will be hidden.
type: boolean
playbar:
description: If set to true, the playbar will be available. If set to false, it will be hidden.
type: boolean
playButton:
description: Indicates if the play button is visible.
type: boolean
playerColor:
description: Changes the base color of the player. Expects a hexadecimal rgb string.
type: string
playlistLinks:
description: Enables the use of specially crafted links on the page to associate with a video, turning them into a playlist.
type: boolean
playlistLoop:
description: If set to true and this video has a playlist, it will loop back to the first video after the last one has finished.
type: boolean
playsinline:
description: If set to false, videos will play within the native mobile player.
type: boolean
playPauseNotifier:
description: If set to false, animations for the Pause and Play symbols will be removed.
type: boolean
playSuspendedOffScreen:
description: If set to false for a muted autoplay video, the video won't pause when out of view.
type: boolean
plugin:
unevaluatedProperties: false
type: object
properties:
videoThumbnail:
unevaluatedProperties: false
type: object
properties:
clickToPlayButton:
description: If set to false, removes the “Click to Play” button on video thumbnails.
type: boolean
socialbar-v1:
unevaluatedProperties: false
type: object
properties:
buttons:
type: string
showTweetCount:
type: boolean
tweetText:
type: string
height:
type: integer
chapters:
unevaluatedProperties: false
type: object
properties:
visibleOnLoad:
type: boolean
chapterList:
type: array
items:
unevaluatedProperties: false
type: object
properties:
id:
type: string
title:
type: string
time:
type: string
deleted:
type: string
'on':
type: boolean
postRoll-v1:
unevaluatedProperties: false
description: Adds a Call To Action to your Video
type: object
properties:
rewatch:
description: If set to true, allows the video to be rewatched.
type: boolean
text:
description: The URL of the text to be displayed.
type: string
link:
description: The URL of the link to be displayed.
type: string
time:
unevaluatedProperties: false
description: The time when the post-roll should be displayed. Can be a string like "end" or a number representing seconds.
oneOf:
- type: string
- type: number
autoSize:
description: If set to true, the post-roll will automatically adjust its size.
type: boolean
style:
unevaluatedProperties: false
type: object
properties:
backgroundColor:
description: The background color of the post-roll.
type: string
examples:
- '#303030'
ctaType:
description: The type of call-to-action to be displayed. Typically set to "text". Other options are "image" which allows for "altText", and "html".
type: string
examples:
- text
'on':
description: If set to true, the post-roll is enabled.
type: boolean
conversionOpportunityKey:
description: The key used for tracking conversion opportunities.
type: string
captions-v1:
unevaluatedProperties: false
description: Enables closed captions for the video
type: object
properties:
'on':
description: If set to true, the captions plugin is enabled and captions controls will be available to viewers.
type: boolean
onByDefault:
description: If set to true, captions will be turned on automatically when the video loads. Only takes effect when the captions plugin is enabled.
type: boolean
preload:
description: Sets the video’s preload property. Possible values are metadata, auto, none, true, and false.
type: string
qualityControl:
description: If set to false, the video quality selector in the settings menu will be hidden.
type: boolean
qualityMax:
description: Specifies the maximum quality the video will play at.
type: integer
qualityMin:
description: Specifies the minimum quality the video will play at.
type: integer
resumable:
description: Determines if the video should resume from where the viewer left off. Options are true, false, and auto.
type: string
seo:
description: If set to true, the video’s metadata will be injected into the page’s markup for SEO.
type: boolean
settingsControl:
description: If set to true, the settings control will be available.
type: boolean
silentAutoPlay:
description: Determines how videos handle autoplay in contexts where normal autoplay might be blocked. Options are true, allow, and false.
type: string
smallPlayButton:
type: boolean
stillUrl:
description: Overrides the thumbnail image that appears before the video plays.
type: string
time:
description: Sets the starting time of the video.
type: string
thumbnailAltText:
description: Sets the Thumbnail Alt Text for the media.
type: string
videoFoam:
unevaluatedProperties: false
description: When set to true, the video will adjust its size according to its parent element. It can also be an object specifying min/max width or height.
anyOf:
- type: boolean
examples:
- true
- type: object
properties:
minWidth:
description: Minimum width the video can be resized to.
type: integer
maxWidth:
description: Maximum width the video can be resized to.
type: integer
minHeight:
description: Minimum height the video can be resized to.
type: integer
maxHeight:
description: Maximum height the video can be resized to.
type: integer
description: "Examples:\n```json\n{\n \"minWidth\": 400,\n \"maxWidth\": 960\n}\n```\n```json\n{\n \"minHeight\": 300,\n \"maxHeight\": 450\n}\n```\n"
volume:
description: Sets the volume of the video.
type: number
volumeControl:
description: When set to true, a volume control is available over the video.
type: boolean
wmode:
description: If set to transparent, the background behind the player will be transparent instead of black.
type: string
responses:
'201':
description: Successful response
content:
application/json:
schema:
unevaluatedProperties: false
type: object
properties:
playerColor:
description: The color of the video player.
type: string
stillUrl:
type: string
autoPlay:
description: Whether the video should auto play or not.
type: string
bpbTime:
type: string
controlsVisibleOnLoad:
type: string
endVideoBehavior:
description: Behavior of the video at the end.
type: string
fullscreenButton:
type: string
branding:
type: string
playbar:
type: string
playButton:
description: Indicates if the play button is visible.
type: string
settingsControl:
type: string
showCustomerLogo:
type: string
qualityControl:
type: string
playbackRateControl:
type: string
smallPlayButton:
type: string
spherical:
type: string
volumeControl:
type: string
copyLinkAndThumbnailEnabled:
type: string
doNotTrack:
type: string
email:
type: string
fitStrategy:
type: string
fullscreenOnRotateToLandscape:
type: string
muted:
type: string
playlistLinks:
type: string
playlistLoop:
type: string
playsinline:
type: string
playPauseNotifier:
type: string
playSuspendedOffScreen:
type: string
preload:
type: string
qualityMax:
type: string
qualityMin:
type: string
resumable:
type: string
seo:
type: string
silentAutoPlay:
type: string
time:
type: string
thumbnailAltText:
type: string
videoFoam:
type: string
volume:
type: string
wmode:
type: string
keyMoments:
description: String representation of whether the key moments feature is enabled.
type: string
plugin:
unevaluatedProperties: true
type: object
properties:
passwordProtectedVideo:
unevaluatedProperties: false
type: object
properties:
'on':
type: string
src:
type: string
challenge:
type: string
async:
type: string
videoThumbnail:
unevaluatedProperties: false
type: object
properties:
clickToPlayButton:
type: string
socialbar-v1:
unevaluatedProperties: false
type: object
properties:
buttons:
type: string
showTweetCount:
type: string
tweetText:
type: string
height:
type: string
chapters:
unevaluatedProperties: false
type: object
properties:
visibleOnLoad:
type: string
chapterList:
type: array
items:
unevaluatedProperties: false
type: object
properties:
id:
type: string
title:
type: string
time:
type: string
deleted:
type: string
'on':
type: string
postRoll-v1:
unevaluatedProperties: false
description: Adds a Call To Action to your Video (response format)
type: object
properties:
rewatch:
description: String representation of whether the video can be rewatched.
type: string
text:
description: The URL of the text to be displayed.
type: string
link:
description: The URL of the link to be displayed.
type: string
time:
description: The time when the post-roll should be displayed as a string.
type: string
autoSize:
description: String representation of whether the post-roll will automatically adjust its size.
type: string
style:
unevaluatedProperties: false
type: object
properties:
backgroundColor:
description: The background color of the post-roll.
type: string
ctaType:
description: The type of call-to-action to be displayed.
type: string
# --- truncated at 32 KB (224 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wistia/refs/heads/main/openapi/wistia-customizations-api-openapi.yml