Skip to main content
Wistia logo
  • Category: video & audio
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: WISTIA
  • Version: 20261101_00

Tools

Slug: WISTIA_CREATE_FOLDERCreate a Wistia folder for organizing media, optionally make it public, and optionally set the specified email as its owner.

Input Parameters

string
required
Name of the new folder.
boolean
Whether the folder is publicly accessible.
string
Email address of the person to set as the folder owner. Defaults to the Wistia Account Owner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_DELETE_FOLDERDelete a Wistia folder by hashed ID, including the media inside it. This is destructive, but deleted content may remain recoverable for a limited account-dependent window before permanent purge.

Input Parameters

string
required
Hashed ID of the folder to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_DELETE_MEDIADelete one Wistia media item by hashed ID. This is destructive, but Wistia keeps deleted media recoverable for a limited account-dependent window before permanent purge.

Input Parameters

string
required
Hashed ID of the media item to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_GET_ANALYTICS_SUMMARYReturn account-wide or single-media Wistia performance metrics for an inclusive start date and exclusive end date.

Input Parameters

string
required
Exclusive analytics end date in YYYY-MM-DD format; must be after start_date.
string
required
Inclusive analytics start date in YYYY-MM-DD format.
string
Optional media hashed ID. Omit for account-wide metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_GET_MEDIAReturn detailed metadata, assets, folder placement, tags, and processing state for one Wistia media item.

Input Parameters

string
required
Hashed ID of the media item.
string
Return the media description as markdown.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_GET_MEDIA_CUSTOMIZATIONSReturn explicitly saved Wistia player customization and plugin settings for one media item.

Input Parameters

string
required
Hashed ID of the media item whose saved player settings to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_GET_MEDIA_STATSReturn undated lifetime viewing statistics for one Wistia media item.

Input Parameters

string
required
Hashed or numeric ID of the media item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_IMPORT_MEDIA_FROM_URLStart importing a publicly reachable media URL into Wistia, optionally into a folder. The response may be queued; call WISTIA_GET_MEDIA until its status is ready before using the media.

Input Parameters

string
required
Publicly reachable URL of the media file to import.
string
Optional display name for the imported media.
string
Optional media description.
boolean
Queue the import at lower processing priority.
string
Optional hashed ID of the destination folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_LIST_MEDIAReturn one page of media in the connected Wistia account with optional inventory filters and sorting.

Input Parameters

string
Exact media name to match.
integer
One-based page number to return.
array
Tag names that every returned media item must match.
string
Include active transcript speaker assignments in each media item.
string ("id" | "name" | "created" | "updated" | "position")
Field used to order results. Cursor pagination requires id or created; page pagination also supports name, updated, and position.
boolean
Filter to archived media when true or active media when false.
integer
Maximum number of media items to return, up to 100.
string
Hashed ID of the folder whose media items to return.
array
Hashed media IDs to fetch as a batch.
string ("Video" | "Audio" | "Image" | "PdfDocument" | "MicrosoftOfficeDocument" | "Swf" | "UnknownType")
Wistia media type to return.
string
Return the media page immediately after this cursor.
string
Return the media page immediately before this cursor.
integer ("0" | "1")
Set to 1 to enable stable cursor pagination or 0 to disable it; do not combine with page.
integer ("0" | "1")
Sort direction: 0 for descending or 1 for ascending.
string
Return media descriptions in markdown format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_LIST_MEDIA_CAPTIONSReturn caption and transcript tracks attached to one Wistia media item.

Input Parameters

string
required
Hashed ID of the media item whose caption tracks to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_LIST_MEDIA_ENGAGEMENT_EVENTSReturn one page of individual viewing events retained from the last two years, optionally filtered by Wistia media item, visitor, or date range.

Input Parameters

integer
One-based page number to return.
string
End date in YYYY-MM-DD format.
string
Optional identifier of the media item whose events to return.
integer
Maximum number of events to return, up to 100.
string
Start date in YYYY-MM-DD format.
string
Optional identifier of the visitor whose events to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_SEARCH_CONTENTSearch the connected Wistia account for media, folders, subfolders, channels, and channel episodes by text and optional filters.

Input Parameters

array
Optional tag names; results matching any supplied tag are returned.
string
required
Text to search for in Wistia content.
string
Only return resources created at or after this UTC ISO 8601 timestamp.
string
Only return resources created at or before this UTC ISO 8601 timestamp.
array
Optional resource types: media, folder, subfolder, channel, or channel_episode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_SET_MEDIA_ARCHIVED_STATEArchive one or more media items, or restore archived media into a destination folder, and wait for Wistia’s background job to finish. Requires the connected account to have access to Wistia’s Archiving feature.

Input Parameters

boolean
required
True to archive the media; false to restore it.
string
Destination folder hashed ID. Required only when restoring media.
array
required
One to 100 media hashed IDs to archive or restore.
integer
Maximum seconds to wait for the background job to finish (1-600).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_UPDATE_FOLDERUpdate a Wistia folder’s name, description, public visibility, or anonymous transfer settings.

Input Parameters

string
New folder name.
boolean
Whether the folder is publicly accessible.
string
New folder description.
string
required
Hashed ID of the folder to update.
boolean
Whether anonymous visitors may upload to the folder.
boolean
Whether anonymous visitors may download from the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_UPDATE_MEDIAUpdate a Wistia media item’s name, description, tags, or still image reference. Wistia returns descriptions as normalized HTML.

Input Parameters

string
New media name.
array
Complete tag-name list to apply to the media. Use an empty list to remove all tags.
string
New media description. Wistia may normalize this content to HTML in the response.
string
required
Hashed ID of the media item to update.
string
Optional media ID to use as the new still image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WISTIA_UPDATE_MEDIA_CUSTOMIZATIONSPartially update explicitly saved Wistia player customization settings for one media item. Null values remove saved keys.

Input Parameters

object
required
Player settings to change. Set a key to null to remove that saved setting; additional provider or plugin keys are accepted.
string
required
Hashed ID of the media item whose player settings to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not