← Back to Home

Tool Reference

Complete reference for all 296 MCP tools. Use these with natural language prompts in Claude, Cursor, or any MCP-compatible client.

🎬 Videos

Manage your video library - list, create, update, delete, and download videos. Includes comprehensive filtering by category, monetization status, dates, and more.

Example prompts:

  • "Show me all videos in the Action genre"
  • "Find subscription-required videos updated this week"
  • "Create a new video called 'Product Demo 2025'"
  • "Update the description for video ID abc123"
  • "Get download URL for my latest video"

6 Tools

list_videos

List videos from your Zype library with comprehensive filtering.

More details
**FILTERING STRATEGY - Use precise filters over text search:**
- For category-based queries (e.g., "SNL videos", "premium content", "action movies"):
  → Use `category` filter: {"category": {"YouTube Channel": "Saturday Night Live"}}
  → First call list_categories to see available category names and values
- For monetization queries (e.g., "subscription videos", "free content"):
  → Use monetization filters: subscription_required, pass_required, purchase_required
- For series/episodic content:
  → Use series_id, season, episode filters
- For batch operations on known videos:
  → Use `id` array filter instead of searching
- Use `q` (text search) only for fuzzy title/description matching when exact filters don't apply

**Available Filters:**
- Pagination: page, per_page (max 500)
- Text search: q (searches title, source_id, zobject title - use as last resort)
- Status: active, on_air, featured, mature_content, friendly_title, keyword
- Dates: created_at_gte/lte, published_at_gte/lte, updated_at_gte/lte
- Monetization: subscription_required, pass_required, rental_required, purchase_required
- Categories: category object (e.g., {"Genre": "Action", "Premium": "true"})
- Series: series_id, season
- Source: source_id, dpt_enabled, country
- External IDs: youtube_id, vimeo_id, crunchyroll_id, hulu_id
- Batch: id (array of video IDs)

Parameters

active string optional

Filter by active status

"true" | "false" | "all"
category object optional

Filter by category values (e.g., {"Premium": "true", "Genre": "Action"})

country string optional

Filter by country code

created_at_gte string optional

Created at or after (ISO8601)

created_at_lte string optional

Created at or before (ISO8601)

crunchyroll_id string optional

Filter by Crunchyroll ID

dpt_enabled boolean optional

Filter by Dynamic Player Technology

featured boolean optional

Filter featured videos

friendly_title string optional

Filter by URL slug (exact match)

hulu_id string optional

Filter by Hulu ID

id array<string> optional

Filter by specific video IDs (batch lookup)

keyword string optional

Filter by keyword/tag

mature_content boolean optional

Filter mature content

on_air boolean optional

Filter by on-air/broadcasting status

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

pass_required boolean optional

Filter pass-gated videos

per_page number optional

Results per page (default: 10, max: 500)

published_at_gte string optional

Published at or after (ISO8601)

published_at_lte string optional

Published at or before (ISO8601)

purchase_required boolean optional

Filter purchasable videos

q string optional

Search query (searches title, source_id, id, zobject title)

rental_required boolean optional

Filter rental videos

season number optional

Filter by season number

series_id string optional

Filter by series ID

sort string optional

Field to sort by (created_at, published_at, title, updated_at)

source_id string optional

Filter by video source ID

subscription_required boolean optional

Filter subscription-gated videos

updated_at_gte string optional

Updated at or after (ISO8601) - for sync/delta

updated_at_lte string optional

Updated at or before (ISO8601)

vimeo_id string optional

Filter by Vimeo ID

youtube_id string optional

Filter by YouTube ID

zobject_id string optional

Filter by zobject association

get_video

Get comprehensive metadata for a video including status, scheduling, monetization, series info, categories, and external IDs.

Parameters

video_id string required

The unique ID of the video

create_video

Create a new video record with full metadata support. Supports:

More details
- Basic metadata (title, description, keywords)
- Status flags (active, featured, on_air, mature_content)
- Scheduling (published_at, enable_at, disable_at, on_air_at, off_air_at)
- Series/Episode (series_id, season, episode)
- Localization (country, language)
- Classification (genre, rating, parental_guidelines_rating)
- Monetization (subscription_required, purchase_price, rental_price, plan_ids)
- Categories via array: [{"title": "Premium", "value": ["true"]}]
- AI features (transcriptions_enabled)
- External IDs (youtube_id, vimeo_id, etc.)

This creates the metadata record. Add video sources separately.

Parameters

title string required

Video title (required)

active boolean optional

Active in library

categories array<object> optional

Category assignments. Omit `id` to add a new entry; pass the existing entry id from get_video to update an existing one. Example add: [{"category_id": "6439b285101efc0001a067aa", "value": ["true"]}]

country string optional

Country code (e.g., "US")

description string optional

Full description

disable_at string optional

Auto-disable date (ISO8601)

enable_at string optional

Auto-enable date (ISO8601)

episode number optional

Episode number

featured boolean optional

Featured/highlighted

friendly_title string optional

URL-friendly slug

genre string optional

Genre

keywords array<string> optional

Keywords/tags

language string optional

Language code (e.g., "en")

mature_content boolean optional

Contains mature content

on_air boolean optional

Currently broadcasting

ott_description string optional

OTT-specific description

published_at string optional

Publish date (ISO8601)

purchase_price string optional

Purchase price

purchase_required boolean optional

Require purchase

rating string optional

Content rating

rental_duration number optional

Rental duration (hours)

rental_price string optional

Rental price

rental_required boolean optional

Require rental

season number optional

Season number

series_id string optional

Series ID for episodic content

short_description string optional

Short description for listings

subscription_required boolean optional

Require subscription

transcriptions_enabled boolean optional

Enable AI transcription

update_video

Update a video's metadata. Only provided fields are updated. Supports all fields from create_video plus:

More details
- To add a category: provide categories array with {category_id, value} objects (call list_categories first to get the category_id). Omit `id` when adding.
- To update an existing category entry: include the entry's `id` (from get_video) along with category_id and value. Without `id`, you'll create a duplicate entry.
- To schedule auto-enable/disable: use enable_at, disable_at
- To set monetization: subscription_required, purchase_price, etc.
- To link to series: series_id, season, episode

Example add: {"video_id": "...", "categories": [{"category_id": "6439b285101efc0001a067aa", "value": ["true"]}]}
Example update existing: {"video_id": "...", "categories": [{"id": "<entry id from get_video>", "category_id": "6439b285101efc0001a067aa", "value": ["false"]}]}

Parameters

video_id string required

Video ID to update (required)

active boolean optional

Active status

categories array<object> optional

Category assignments. Omit `id` to add a new entry; pass the existing entry id from get_video to update an existing one. Example add: [{"category_id": "6439b285101efc0001a067aa", "value": ["true"]}]

country string optional

Country code

custom_attributes object optional

Custom key-value attributes

description string optional

Full description

disable_at string optional

Auto-disable date

enable_at string optional

Auto-enable date

episode number optional

Episode number

featured boolean optional

Featured status

friendly_title string optional

URL slug

genre string optional

Genre

keywords array<string> optional

Keywords/tags

language string optional

Language code

mature_content boolean optional

Mature content flag

off_air_at string optional

Scheduled on-air end

on_air boolean optional

On-air status

on_air_at string optional

Scheduled on-air start

ott_description string optional

OTT description

parental_guidelines_rating string optional

Parental rating

pass_required boolean optional

Require pass

plan_ids array<string> optional

Plan IDs granting access

published_at string optional

Publish date (ISO8601)

purchase_price string optional

Purchase price

purchase_required boolean optional

Require purchase

rating string optional

Content rating

rental_duration number optional

Rental duration (hours)

rental_price string optional

Rental price

rental_required boolean optional

Require rental

season number optional

Season number

series_id string optional

Series ID

short_description string optional

Short description

subscription_ads_enabled boolean optional

Show ads for subscribers

subscription_required boolean optional

Require subscription

title string optional

Video title

transcriptions_enabled boolean optional

AI transcription

delete_video

Permanently delete a video from Zype. This action cannot be undone.

Parameters

video_id string required

The unique ID of the video to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

download_video

Get the mezzanine/source file download URL for a video. Returns { url, filesize } when the original source file is available. Returns an error if no mezzanine file exists (e.g., for YouTube-sourced videos).

Parameters

video_id string required

The unique ID of the video (required)

📝 Transcriptions

AI-powered transcription and translation. Transcribe video audio to text and translate to multiple languages. Operations are async - check status after initiating.

Example prompts:

  • "Transcribe video abc123"
  • "Translate video abc123 to Spanish"
  • "List all transcriptions for my product video"
  • "What languages can I translate to?"
  • "Get the full transcript for video abc123"

5 Tools

list_transcriptions

List all transcriptions and translations for a video.

More details
Returns both original transcriptions and any translations, with their status (pending, processing, completed, failed).
Use this to check the status of async transcription/translation operations.

Parameters

video_id string required

The video ID to list transcriptions for (required)

page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

get_transcription

Get a single transcription or translation with full details.

More details
Returns complete text content and download URLs for SRT/VTT subtitle files.
Use the transcription_id from list_transcriptions.

Parameters

transcription_id string required

The transcription ID (required)

video_id string required

The video ID (required)

transcribe_video

Initiate AI transcription for a video.

More details
**IMPORTANT:** This is an ASYNC operation. The transcription processes in the background.
- Returns immediately with a pending status
- Use list_transcriptions or get_transcription to check progress
- Video must have a playable source file (mezzanine)
- Once complete, provides full text and SRT/VTT download URLs

Parameters

video_id string required

The video ID to transcribe (required)

translate_video

Initiate AI translation for a video to a target language.

More details
**IMPORTANT:** This is an ASYNC operation. The translation processes in the background.
- Requires an existing transcription (transcribe first if none exists)
- Use list_translation_languages to see available target languages
- Use list_transcriptions or get_transcription to check progress
- Once complete, provides translated text and SRT/VTT download URLs

Parameters

language string required

Target language code, e.g., "es", "fr", "de" (required). Use list_translation_languages to see options.

video_id string required

The video ID to translate (required)

list_translation_languages

List available translation languages for a video. Returns language codes that can be used with translate_video.

Parameters

video_id string required

The video ID (required)

✨ AI Metadata

Generate video metadata with AI - titles, descriptions, keywords, and genre - from the video's transcript. Requires AI Transcriptions enabled and the video transcribed. Single-video generation returns suggestions to review; the bulk tool writes straight onto the videos, so it is gated behind a confirmation.

Example prompts:

  • "Generate a title and keywords for video abc123"
  • "Show me the AI suggestions for video abc123 before I apply them"
  • "Apply the AI title suggestion from session xyz789"
  • "Generate and apply descriptions across these 20 videos"

4 Tools

generate_ai_metadata

Generate AI metadata SUGGESTIONS for one video (title, description, keywords, genre, etc.).

More details
**Safe - the video is NOT modified.** Suggestions are returned for review.
- Returns immediately with the finished values (this call is synchronous)
- Creates one session per requested attribute, each with its own session_id
- To write a value, call apply_ai_metadata with that attribute's session_id (once per attribute)
- Requires a completed transcript on the video, otherwise the API returns 422 (see transcribe_video)

Parameters

video_id string required

The video ID to generate suggestions for (required)

attributes array<string> optional

Attributes to generate: title, friendly_title, description, short_description, keywords, genre. Omit for Zype defaults.

prompt_context_id string optional

Optional prompt context ID (brand voice / style guide configured in Zype) to steer generation

bulk_generate_ai_metadata

Generate AI metadata for many videos AND WRITE IT DIRECTLY ONTO THEM.

More details
**WARNING - THIS IS NOT A SUGGESTION-ONLY TOOL.** Unlike generate_ai_metadata, the bulk
endpoint overwrites each video's metadata with the generated values. There is no review
step, no suggestion to inspect, and no undo through the API.
- Runs asynchronously in the background; returns only a queued count
- Every listed video is modified once processing completes
- In safe mode this requires confirm: true
- Use generate_ai_metadata per video if you want to review before writing
- Each video needs a completed transcript, otherwise it is skipped or errors

Parameters

video_ids array<string> required

Video IDs to generate and apply metadata for (required) - these videos WILL be modified

attributes array<string> optional

Attributes to generate: title, friendly_title, description, short_description, keywords, genre. Omit for Zype defaults.

confirm boolean optional

Set to true to confirm overwriting metadata on every listed video (required in safe mode)

prompt_context_id string optional

Optional prompt context ID (brand voice / style guide configured in Zype) to steer generation

get_ai_metadata

Get one AI metadata suggestion by session_id, including its generated value.

More details
Each session covers a single attribute. Use the session_id values returned by generate_ai_metadata.
Read-only - viewing a suggestion does not modify the video.

Parameters

session_id string required

The AI metadata session ID for one attribute (required)

video_id string required

The video ID (required)

apply_ai_metadata

Apply ONE AI metadata suggestion to the video.

More details
**WARNING:** This overwrites that attribute's existing value on the video and cannot be
undone through the API.
- Each session_id covers a single attribute, so call once per attribute you want written
- Review the value with get_ai_metadata first
- In safe mode this requires confirm: true

Parameters

session_id string required

Session ID of the single attribute to apply (required)

video_id string required

The video ID (required)

confirm boolean optional

Set to true to confirm overwriting the existing value (required in safe mode)

📡 Live

Create and run live events and live encoders - schedule a stream, start and stop encoding, and archive the recording when the event ends.

Example prompts:

  • "List my live events"
  • "Start the encoder for tonight's stream"
  • "Archive the live event once it finishes"

16 Tools

list_live_events

List live events (MSL live streams) in your Zype site, including their schedule, encoder binding, and monetization flags.

Parameters

active boolean optional

Filter by active state

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page

q string optional

Search query

sort string optional

Field to sort by

get_live_event

Get a specific live event by its ID, including schedule, encoder binding, monetization flags, and player embed.

Parameters

live_event_id string required

The unique ID of the live event (required)

create_live_event

Create a new live event (MSL live stream). Provide a title and bind it to a Zype Live encoder via video_source_id (or encoder_id / legacy encoder_name). Optionally set the on-air/off-air schedule, archiving behavior, and monetization requirements.

Parameters

title string required

Title of the live event

auto_archive boolean optional

Whether to automatically archive the stream to a VOD when it ends

auto_manage_encoder boolean optional

Whether Zype automatically starts/stops the encoder with the event

description string optional

Description of the live event

encoder_id string optional

Alias for video_source_id — the encoder backing this event

encoder_name string optional

Legacy: encoder hostname used to resolve the video source when no ID is given

event_type string optional

Live event type (e.g. the encoder/streaming mode)

off_air_at string optional

Scheduled off-air time (ISO 8601)

on_air_at string optional

Scheduled on-air time (ISO 8601)

pass_required boolean optional

Whether a pass is required to watch

purchase_price number optional

Purchase price

purchase_required boolean optional

Whether a purchase is required to watch

redemption_code_required boolean optional

Whether a redemption code is required to watch

rental_duration number optional

Rental duration in hours

rental_price number optional

Rental price

rental_required boolean optional

Whether a rental is required to watch

subscription_required boolean optional

Whether a subscription is required to watch

video_source_id string optional

ID of the Zype Live encoder / video source backing this event

update_live_event

Update an existing live event. Only the fields you provide are changed. Changing video_source_id/encoder_id re-binds the event to a different encoder.

Parameters

live_event_id string required

The unique ID of the live event to update (required)

auto_archive boolean optional

Whether to automatically archive the stream to a VOD when it ends

auto_manage_encoder boolean optional

Whether Zype automatically starts/stops the encoder with the event

description string optional

Description of the live event

encoder_id string optional

Alias for video_source_id — the encoder backing this event

encoder_name string optional

Legacy: encoder hostname used to resolve the video source when no ID is given

event_type string optional

Live event type (e.g. the encoder/streaming mode)

off_air_at string optional

Scheduled off-air time (ISO 8601)

on_air_at string optional

Scheduled on-air time (ISO 8601)

pass_required boolean optional

Whether a pass is required to watch

purchase_price number optional

Purchase price

purchase_required boolean optional

Whether a purchase is required to watch

redemption_code_required boolean optional

Whether a redemption code is required to watch

rental_duration number optional

Rental duration in hours

rental_price number optional

Rental price

rental_required boolean optional

Whether a rental is required to watch

subscription_required boolean optional

Whether a subscription is required to watch

title string optional

Title of the live event

video_source_id string optional

ID of the Zype Live encoder / video source backing this event

delete_live_event

Permanently delete a live event from Zype. This action cannot be undone.

Parameters

live_event_id string required

The unique ID of the live event to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

start_live_event

Put a live event on air (start streaming). The event must be bound to an encoder.

Parameters

live_event_id string required

The unique ID of the live event (required)

stop_live_event

Take a live event off air (stop streaming). If auto_archive is enabled the stream is archived to a VOD.

Parameters

live_event_id string required

The unique ID of the live event (required)

archive_live_event

Archive a live event stream to a video-on-demand asset.

Parameters

live_event_id string required

The unique ID of the live event (required)

list_live_encoders

List live encoders (Zype Live channels) in your site, including status, region, inputs, and destinations. Useful for monitoring live encoding infrastructure health.

No parameters required

get_live_encoder

Get a specific live encoder by its ID, including status, configuration, live inputs, and live destinations.

Parameters

encoder_id string required

The unique ID of the live encoder (required)

create_live_encoder

Create a new live encoder (Zype Live channel). Provide a name and, optionally, a region, event profile, HA/input-switch settings, live inputs (RTMP ingest), and live destinations (HLS/RTMP outputs). Subject to your account's Zype Live channel quota.

Parameters

name string required

Encoder / channel name

event_profile_id string optional

Event profile ID defining the encoding presets

high_availability_enabled boolean optional

Whether the encoder runs in high-availability mode

live_destinations array<object> optional

Live destinations (HLS/RTMP outputs) to create/update/remove

live_inputs array<object> optional

Live inputs (RTMP ingest sources) to create/update/remove

mqcs_input_switch_enabled boolean optional

Whether MQCS automatic input switching is enabled

nielsen_distributor_id string optional

Nielsen distributor ID (when tagging is enabled)

nielsen_tagging boolean optional

Whether Nielsen watermark tagging is enabled

region string optional

AWS region the encoder runs in (set at creation)

update_live_encoder

Update an existing live encoder. Only the fields you provide are changed. To modify inputs/destinations, pass live_inputs/live_destinations: include an item's id to update it, set _destroy: true (with id) to remove it, or omit id to add a new one. Note: a running encoder only accepts a limited set of edits.

Parameters

encoder_id string required

The unique ID of the live encoder to update (required)

event_profile_id string optional

Event profile ID defining the encoding presets

high_availability_enabled boolean optional

Whether the encoder runs in high-availability mode

live_destinations array<object> optional

Live destinations (HLS/RTMP outputs) to create/update/remove

live_inputs array<object> optional

Live inputs (RTMP ingest sources) to create/update/remove

mqcs_input_switch_enabled boolean optional

Whether MQCS automatic input switching is enabled

name string optional

Encoder / channel name

nielsen_distributor_id string optional

Nielsen distributor ID (when tagging is enabled)

nielsen_tagging boolean optional

Whether Nielsen watermark tagging is enabled

region string optional

AWS region the encoder runs in (set at creation)

delete_live_encoder

Permanently delete a live encoder (Zype Live channel). This tears down the underlying encoding infrastructure and cannot be undone.

Parameters

encoder_id string required

The unique ID of the live encoder to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

start_live_encoder

Start a live encoder (Zype Live channel) so it begins ingesting and encoding its live signal.

Parameters

encoder_id string required

The unique ID of the live encoder (required)

stop_live_encoder

Stop a running live encoder (Zype Live channel).

Parameters

encoder_id string required

The unique ID of the live encoder (required)

sync_live_encoder

Refresh a live encoder's state from the underlying encoding provider — useful for reconciling status and monitoring health.

Parameters

encoder_id string required

The unique ID of the live encoder (required)

🗓️ Program Guides

Manage EPG program guides and their entries - the schedule data that powers channel listings.

Example prompts:

  • "List my program guides"
  • "Show the entries in the primary program guide"

6 Tools

list_program_guides

List program guides (EPG schedules) in your Zype library, with optional search, sorting, and pagination.

Parameters

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

q string optional

Search query

sort string optional

Field to sort by

get_program_guide

Get detailed information about a specific program guide by its ID, including associated videos.

Parameters

program_guide_id string required

The unique ID of the program guide (required)

create_program_guide

Create a new program guide (EPG schedule). Provide a name, a source URL for syncing content, language(s), and a time zone.

Parameters

language undefined required

Language code(s), e.g. 'en' or ['en', 'fr']

name string required

Name of the program guide (required)

time_zone string required

Time zone, e.g. 'America/New_York' (required)

url string required

Source URL for syncing guide content (required)

video_ids array<string> optional

Video IDs to associate with the guide

update_program_guide

Update an existing program guide. Only the fields you provide are changed.

Parameters

program_guide_id string required

The unique ID of the program guide to update (required)

language undefined optional

Language code(s), e.g. 'en' or ['en', 'fr']

name string optional

New name

time_zone string optional

New time zone

url string optional

New source URL

video_ids array<string> optional

New set of associated video IDs

delete_program_guide

Permanently delete a program guide from Zype. This action cannot be undone.

Parameters

program_guide_id string required

The unique ID of the program guide to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

list_program_guide_entries

List the entries (scheduled programs) within a program guide.

More details
Each entry has a title, description, and start/end times. Filter by title, search query, or a start_time/end_time window (ISO8601 or Unix timestamps).

Parameters

program_guide_id string required

The program guide ID to list entries for (required)

disable_pagination boolean optional

Return all entries without pagination

end_time string optional

Filter by end_time (ISO8601 or Unix timestamp)

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

q string optional

Search query

sort string optional

Field to sort by

start_time string optional

Filter by start_time (ISO8601 or Unix timestamp)

title string optional

Filter by entry title

🌍 Content Rules

Geo and IP targeting. Content rule profiles bundle rule groups; groups define the countries, regions and addresses a rule applies to. Global groups are a read-only catalogue Zype maintains.

Example prompts:

  • "List my content rule profiles"
  • "Create a rule group blocking a country"
  • "What global content rule groups are available?"

12 Tools

list_content_rule_profiles

List content rule profiles — named sets of geo/IP access rules — in your Zype site.

Parameters

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page

q string optional

Search query

sort string optional

Field to sort by

get_content_rule_profile

Get a specific content rule profile by its ID, including all of its nested content rules.

Parameters

content_rule_profile_id string required

The unique ID of the content rule profile (required)

create_content_rule_profile

Create a new content rule profile (a named set of geo/IP access rules).

More details
Provide a title and, optionally, a description, whether it is the site's default profile, and a list of nested content rules. Each rule has a policy (allow/deny), a priority, a match_type, location criteria (countries, states, cities, zip_codes, dma_codes, ip_addresses, ip_ranges), and content_rule_group_ids identifying the content rule groups it targets.

Parameters

title string required

Title of the content rule profile (required)

content_rules array<object> optional

Nested content rules to create with the profile

description string optional

Description of the profile

is_default_profile boolean optional

Whether this is the default profile for the site

update_content_rule_profile

Update an existing content rule profile. Only the fields you provide are changed.

More details
To modify nested rules, pass content_rules: include an existing rule's id to update it, set _destroy: true (with id) to remove it, or omit id to add a new rule.

Parameters

content_rule_profile_id string required

The unique ID of the content rule profile to update (required)

content_rules array<object> optional

Nested content rules to add, update (with id), or remove (with _destroy)

description string optional

New description

is_default_profile boolean optional

Whether this is the default profile for the site

title string optional

New title

delete_content_rule_profile

Permanently delete a content rule profile from Zype. This action cannot be undone.

Parameters

content_rule_profile_id string required

The unique ID of the content rule profile to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

list_content_rule_groups

List all custom content rule groups (geo/IP targeting rule sets) for your site, ordered by name.

No parameters required

get_content_rule_group

Get a single content rule group by its ID, including its group type and all matching values.

Parameters

content_rule_group_id string required

The unique ID of the content rule group (required)

create_content_rule_group

Create a new content rule group. Provide a name, a group_type, and the matching values for that type (e.g. countries for a country group, ip_addresses/ip_ranges for an ip_address group).

Parameters

name string required

Name of the content rule group (required)

cities array<string> optional

City names; required for city groups

countries array<string> optional

ISO 3166-1 alpha-2 country codes (uppercase); required for country groups

dma_codes array<string> optional

DMA codes; required for dma_code groups

group_type string optional

Rule matching type (default: country)

"country" | "state" | "city" | "zip_code" | "dma_code" | "ip_address"
ip_addresses array<string> optional

Single hosts or CIDR blocks

ip_ranges array<object> optional

Start/end IP address pairs

states array<string> optional

US state codes (uppercase); required for state groups

zip_codes array<string> optional

ZIP/postal codes; required for zip_code groups

update_content_rule_group

Update an existing content rule group. Only the fields you provide are changed.

Parameters

content_rule_group_id string required

The unique ID of the content rule group to update (required)

cities array<string> optional

City names; required for city groups

countries array<string> optional

ISO 3166-1 alpha-2 country codes (uppercase); required for country groups

dma_codes array<string> optional

DMA codes; required for dma_code groups

group_type string optional

Rule matching type (default: country)

"country" | "state" | "city" | "zip_code" | "dma_code" | "ip_address"
ip_addresses array<string> optional

Single hosts or CIDR blocks

ip_ranges array<object> optional

Start/end IP address pairs

name string optional

New name

states array<string> optional

US state codes (uppercase); required for state groups

zip_codes array<string> optional

ZIP/postal codes; required for zip_code groups

delete_content_rule_group

Permanently delete a content rule group from Zype. This action cannot be undone.

Parameters

content_rule_group_id string required

The unique ID of the content rule group to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

list_global_content_rule_groups

List the global content rule groups catalog (geo/IP targeting rule groups shared across sites), ordered by name. Supports optional search, sorting, and pagination.

Parameters

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

q string optional

Search query

sort string optional

Field to sort by

get_global_content_rule_group

Get a single global content rule group from the catalog by its ID, including its geo/IP targeting lists (countries, states, cities, zip codes, DMA codes, IP addresses, and IP ranges).

Parameters

global_content_rule_group_id string required

The unique ID of the global content rule group (required)

🎛️ Playout Scheduler

Run linear channels: build a draft rundown, publish it on air, manage destinations and output profiles, and schedule assets. Requires the site to be provisioned for Playout - a 401 here means the feature is not enabled, not that your key is wrong.

Example prompts:

  • "What is scheduled on the news channel today?"
  • "Publish the draft rundown for channel abc123"
  • "Add a bumper to the schedule before the 8pm block"
  • "Show me the Roku EPG feed for this channel"

79 Tools

playout_create_ad_timing

Create Ad Timing. Playout Scheduler (Assets).

Parameters

body object optional

Request body fields for this operation

playout_create_block

Create Block. Playout Scheduler (Assets).

Parameters

body object optional

Request body fields for this operation

playout_create_channel

Create Channel. Playout Scheduler (Channels).

Parameters

body object optional

Request body fields for this operation

playout_create_destination

Create Destination. Playout Scheduler (Destinations).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_create_draft_operation

Create Operation. Playout Scheduler (Timeline Operations).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_create_graphic

Create Graphic. Playout Scheduler (Assets).

Parameters

body object optional

Request body fields for this operation

playout_create_hls_profile

Create HLS Profile. Playout Scheduler (HLS Profiles).

Parameters

body object optional

Request body fields for this operation

playout_create_live_stream

Create Live Asset. Playout Scheduler (Assets).

Parameters

channel_id string required

channelId (required)

body object optional

Request body fields for this operation

playout_create_recurrence_rule

Create Recurrence Rule. Playout Scheduler (Recurrence Rules).

Parameters

body object optional

Request body fields for this operation

playout_create_rtmp_profile

Create RTMP Profile. Playout Scheduler (RTMP Profiles).

Parameters

body object optional

Request body fields for this operation

playout_create_udp_profile

Create UDP Profile. Playout Scheduler (UDP Profiles).

Parameters

body object optional

Request body fields for this operation

playout_create_upload

Create Upload. Playout Scheduler (Uploads).

Parameters

body object optional

Request body fields for this operation

playout_delete_ad_timing

Delete Ad Timing. Playout Scheduler (Assets). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_all_ad_timings

Delete Ad Timings. Playout Scheduler (Assets). **Destructive** - requires confirm: true in safe mode.

Parameters

asset_id string optional

assetId

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_block

Delete Block. Playout Scheduler (Assets). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_channel

Delete Channel. Playout Scheduler (Channels). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_destination

Delete Destination. Playout Scheduler (Destinations). **Destructive** - requires confirm: true in safe mode.

Parameters

destination_id string required

destinationId (required)

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_graphic

Delete Graphic. Playout Scheduler (Assets). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_hls_profile

Delete HLS Profile. Playout Scheduler (HLS Profiles). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_live_stream

Delete Live Asset. Playout Scheduler (Assets). **Destructive** - requires confirm: true in safe mode.

Parameters

channel_id string required

channelId (required)

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_recurrence_rule

Delete Recurrence Rule. Playout Scheduler (Recurrence Rules). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_rtmp_profile

Delete RTMP Profile. Playout Scheduler (RTMP Profiles). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_delete_udp_profile

Delete UDP Profile. Playout Scheduler (UDP Profiles). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_discard_draft_operations

Revert all operations. Playout Scheduler (Timeline Operations). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

playout_duplicate_hls_profile

Duplicate HLS Profile. Playout Scheduler (HLS Profiles).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_duplicate_rtmp_profile

Duplicate RTMP Profile. Playout Scheduler (RTMP Profiles).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_duplicate_udp_profile

Duplicate UDP Profile. Playout Scheduler (UDP Profiles).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_get_ad

View Ad. Playout Scheduler (Assets).

Parameters

id string required

id (required)

playout_get_asset_type

View Destination Type. Playout Scheduler (Destinations).

Parameters

id string required

id (required)

playout_get_block

View Block. Playout Scheduler (Assets).

Parameters

id string required

id (required)

playout_get_bumper

View Bumper. Playout Scheduler (Assets).

Parameters

id string required

id (required)

playout_get_channel

View Channel. Playout Scheduler (Channels).

Parameters

id string required

id (required)

playout_get_destination

View Destination. Playout Scheduler (Destinations).

Parameters

destination_id string required

destinationId (required)

id string required

id (required)

playout_get_draft

View Channel's Draft. Playout Scheduler (Draft Versions).

Parameters

id string required

id (required)

auto_graphics string optional

autoGraphics

ends_at string optional

endsAt

starts_at string optional

startsAt

playout_get_draft_operation

View Operation. Playout Scheduler (Timeline Operations).

Parameters

id string required

id (required)

operation_id string required

operationId (required)

playout_get_draft_rundown

View Channel Draft's Schedule Rundown. Playout Scheduler (Draft Versions).

Parameters

id string required

id (required)

hours string optional

hours

start string optional

start

playout_get_epg_roku

Roku EPG. Playout Scheduler (EPG).

Parameters

id string required

id (required)

custom_thumbnail string optional

custom_thumbnail

playout_get_epg_tcl

Tcl EPG. Playout Scheduler (EPG).

Parameters

id string required

id (required)

custom_thumbnail string optional

custom_thumbnail

playout_get_epg_vizio

Vizio EPG. Playout Scheduler (EPG).

Parameters

id string required

id (required)

custom_thumbnail string optional

custom_thumbnail

playout_get_epg_wurl

Wurl EPG. Playout Scheduler (EPG).

Parameters

id string required

id (required)

custom_thumbnail string optional

custom_thumbnail

playout_get_graphic

View Graphic. Playout Scheduler (Assets).

Parameters

id string required

id (required)

playout_get_hls_profile

View HLS Profile. Playout Scheduler (HLS Profiles).

Parameters

id string required

id (required)

playout_get_playlist

View Playlist. Playout Scheduler (Assets).

Parameters

id string required

id (required)

playout_get_published

View Channel's Published. Playout Scheduler (Published Versions).

Parameters

id string required

id (required)

starts_at string optional

startsAt

playout_get_published_rundown

JSON Rundown EPG. Playout Scheduler (EPG).

Parameters

id string required

id (required)

hours string optional

hours

mode string optional

mode

start string optional

start

playout_get_published_rundown_xmltv

View Channel's Published Rundown XMLTV format. Playout Scheduler (EPG).

Parameters

id string required

id (required)

custom_thumbnail string optional

custom_thumbnail

date_format string optional

date_format

mode string optional

mode

with_time_zone string optional

with_time_zone

playout_get_recurrence_rule

View Recurrence Rule. Playout Scheduler (Recurrence Rules).

Parameters

id string required

id (required)

playout_get_rtmp_profile

View RTMP Profile. Playout Scheduler (RTMP Profiles).

Parameters

id string required

id (required)

playout_get_udp_profile

View UDP Profile. Playout Scheduler (UDP Profiles).

Parameters

id string required

id (required)

playout_get_upload

Get Upload. Playout Scheduler (Uploads).

Parameters

id string required

id (required)

playout_get_video

View Video. Playout Scheduler (Assets).

Parameters

id string required

id (required)

playout_graphics_sync_channel

Sync automated graphic insertions. Playout Scheduler (Channels).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_list_ad_timings

List Ad Timings. Playout Scheduler (Assets).

Parameters

asset_id string optional

assetId

playout_list_ads

List Ads. Playout Scheduler (Assets).

Parameters

q string optional

q

playout_list_asset_types

List Destination Types. Playout Scheduler (Destinations).

Parameters

page string optional

page

per_page string optional

per_page

playout_list_blocks

List Blocks. Playout Scheduler (Assets).

Parameters

dynamic string optional

dynamic

id string optional

id

order string optional

order

q string optional

q

sort string optional

sort

playout_list_bumpers

List Bumpers. Playout Scheduler (Assets).

Parameters

q string optional

q

playout_list_channels

List Channels. Playout Scheduler (Channels).

Parameters

page string optional

page

per_page string optional

per_page

playout_list_destinations

List Destinations. Playout Scheduler (Destinations).

Parameters

id string required

id (required)

playout_list_draft_item_graphics

View track item's automated graphics. Playout Scheduler (Draft Versions).

Parameters

id string required

id (required)

item_id string required

itemId (required)

playout_list_draft_operations

List Operations. Playout Scheduler (Timeline Operations).

Parameters

id string required

id (required)

playout_list_graphics

List Graphics. Playout Scheduler (Assets).

Parameters

q string optional

q

playout_list_live_streams

List Live Assets. Playout Scheduler (Assets).

Parameters

channel_id string required

channelId (required)

q string optional

q

playout_list_playlists

List Playlists. Playout Scheduler (Assets).

Parameters

q string optional

q

playout_list_recurrence_rules

List Recurrence Rules. Playout Scheduler (Recurrence Rules).

Parameters

channel_id string optional

channelId

load_asset string optional

loadAsset

page string optional

page

per_page string optional

per_page

playout_list_videos

List Videos. Playout Scheduler (Assets).

Parameters

q string optional

q

playout_publish_draft

Publish Channel's Draft. Playout Scheduler (Draft Versions). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

confirm boolean optional

Set true to confirm (required in safe mode)

playout_revert_operation

Revert a Draft Schedule to the specified operation. Playout Scheduler (Timeline Operations). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

operation_id string required

operationId (required)

body object optional

Request body fields for this operation

confirm boolean optional

Set true to confirm (required in safe mode)

playout_stop_channel

Stop On-Air Channel. Playout Scheduler (Channels). **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

confirm boolean optional

Set true to confirm (required in safe mode)

playout_update_ad_timing

Update Ad Timing. Playout Scheduler (Assets).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_block

Update Block. Playout Scheduler (Assets).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_channel

Update Channel. Playout Scheduler (Channels).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_destination

Update Destination. Playout Scheduler (Destinations).

Parameters

destination_id string required

destinationId (required)

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_graphic

Update Graphic. Playout Scheduler (Assets).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_hls_profile

Update HLS Profile. Playout Scheduler (HLS Profiles).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_live_stream

Update Live Asset. Playout Scheduler (Assets).

Parameters

channel_id string required

channelId (required)

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_recurrence_rule

Update Recurrence Rule. Playout Scheduler (Recurrence Rules).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_rtmp_profile

Update RTMP Profile. Playout Scheduler (RTMP Profiles).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

playout_update_udp_profile

Update UDP Profile. Playout Scheduler (UDP Profiles).

Parameters

id string required

id (required)

body object optional

Request body fields for this operation

👤 Consumers

End-user accounts, their video and playlist entitlements, subscription entitlements, favorites, and TV device pairing. These endpoints expose personal data and every write affects a real person, so deletions, entitlement revocations and the two endpoints that send email are gated behind a confirmation.

Example prompts:

  • "Which videos is this consumer entitled to?"
  • "Grant consumer xyz access to video abc123"
  • "Link this TV device PIN to a consumer account"

26 Tools

list_consumers

List consumer (end-user) accounts. Returns PII including email addresses.

Parameters

email string optional

Exact email

order string optional
"asc" | "desc"
page number optional

Page number

per_page number optional

Results per page (max 500)

q string optional

Search keyword

sort string optional

Sort field

get_consumer

Get a single consumer account by ID, including their PII.

Parameters

consumer_id string required

The consumer ID (required)

create_consumer

Create a consumer (end-user) account with an email and password.

Parameters

email string required

Email address (required)

password string required

Password (required)

consumer_id string optional

Your own external identifier

name string optional

Display name

update_consumer

Update a consumer's email, name, or password.

Parameters

consumer_id string required

The consumer ID (required)

email string optional

New email

name string optional

New name

password string optional

New password

delete_consumer

Permanently DELETE a consumer account and their entitlements. Cannot be undone.

Parameters

consumer_id string required

The consumer ID (required)

confirm boolean optional

Set to true to confirm (required in safe mode)

reset_consumer_parental_access_code

Reset a consumer's parental access code. This SENDS THEM AN EMAIL.

Parameters

consumer_id string required

The consumer ID (required)

confirm boolean optional

Set to true to confirm (required in safe mode)

send_consumer_forgot_password

Start the forgot-password flow. This SENDS THE CONSUMER AN EMAIL.

Parameters

email string required

Email address (required)

confirm boolean optional

Set to true to confirm (required in safe mode)

list_video_entitlements

List the videos a consumer is entitled to.

Parameters

consumer_id string required

The consumer ID (required)

page number optional

Page number

per_page number optional

Results per page (max 500)

get_video_entitlement

Get one video entitlement for a consumer.

Parameters

consumer_id string required

The consumer ID (required)

entitlement_id string required

The entitlement ID (required)

create_video_entitlement

Grant a consumer access to a video.

Parameters

consumer_id string required

The consumer ID (required)

video_id string required

Video to grant (required)

expires_at string optional

Expiry ISO8601; omit for permanent

update_video_entitlement

Change a video entitlement's expiry.

Parameters

consumer_id string required

The consumer ID (required)

entitlement_id string required

The entitlement ID (required)

expires_at string optional

New expiry ISO8601

delete_video_entitlement

Revoke a video entitlement. The consumer immediately loses access.

Parameters

consumer_id string required

The consumer ID (required)

entitlement_id string required

The entitlement ID (required)

confirm boolean optional

Set to true to confirm (required in safe mode)

check_video_entitled

Check whether a video is accessible, optionally on behalf of a consumer.

Parameters

video_id string required

The video ID (required)

consumer_id string optional

Consumer to check for

list_playlist_entitlements

List the playlists a consumer is entitled to.

Parameters

consumer_id string required

The consumer ID (required)

page number optional

Page number

per_page number optional

Results per page (max 500)

get_playlist_entitlement

Get one playlist entitlement for a consumer.

Parameters

consumer_id string required

The consumer ID (required)

entitlement_id string required

The entitlement ID (required)

create_playlist_entitlement

Grant a consumer access to a playlist.

Parameters

consumer_id string required

The consumer ID (required)

playlist_id string required

Playlist to grant (required)

expires_at string optional

Expiry ISO8601

update_playlist_entitlement

Change a playlist entitlement's expiry.

Parameters

consumer_id string required

The consumer ID (required)

entitlement_id string required

The entitlement ID (required)

expires_at string optional

New expiry ISO8601

delete_playlist_entitlement

Revoke a playlist entitlement. The consumer immediately loses access.

Parameters

consumer_id string required

The consumer ID (required)

entitlement_id string required

The entitlement ID (required)

confirm boolean optional

Set to true to confirm (required in safe mode)

list_subscription_entitlements

List a consumer's subscription entitlements - what their subscription unlocks.

Parameters

consumer_id string required

The consumer ID (required)

list_video_favorites

List a consumer's favorited videos.

Parameters

consumer_id string required

The consumer ID (required)

page number optional

Page number

per_page number optional

Results per page (max 500)

create_video_favorite

Add a video to a consumer's favorites.

Parameters

consumer_id string required

The consumer ID (required)

video_id string required

Video to favorite (required)

delete_video_favorite

Remove a video from a consumer's favorites.

Parameters

consumer_id string required

The consumer ID (required)

favorite_id string required

The favorite entry ID (required)

confirm boolean optional

Set to true to confirm (required in safe mode)

acquire_device_pin

Acquire a pairing PIN for a TV/streaming device.

Parameters

device_id string optional

Device identifier

get_device_pin_status

Check whether a device PIN has been linked yet.

Parameters

pin string required

The device PIN (required)

⚙️ Platform

Admin site users, video segments, video sources and imports, self-hosted data sources, ad timings, devices and device categories, GeoIP lookup, and the legacy live encoders.

Example prompts:

  • "Who has admin access to this site?"
  • "Import a video from this URL"
  • "List the ad timings on video abc123"
  • "What device categories do we support?"

48 Tools

add_zobjects_to_video

Add Zobject(s).

Parameters

id string required

id (required)

body object optional

Request body fields

attach_video_to_import

Attach a Video to a Video Import.

Parameters

id string required

id (required)

body object optional

Request body fields

create_ad_timing

Create Ad Timing.

Parameters

data_source_id string required

data_source_id (required)

id string required

id (required)

body object optional

Request body fields

create_segment

Create Segment.

Parameters

video_id string required

video_id (required)

body object optional

Request body fields

create_self_hosted_source

Create Self Hosted Video.

Parameters

body object optional

Request body fields

create_site_user

Create User.

Parameters

body object optional

Request body fields

create_video_import

Create Video Import.

Parameters

body object optional

Request body fields

create_video_self_hosted_source

Create a Self Hosted Video Data Source.

Parameters

video_id string required

video_id (required)

body object optional

Request body fields

create_video_source

Create Video Source.

Parameters

body object optional

Request body fields

delete_ad_timing

Destroy Ad Timing. **Destructive** - requires confirm: true in safe mode.

Parameters

ad_timing_id string required

ad_timing_id (required)

data_source_id string required

data_source_id (required)

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

delete_segment

Delete Segment. **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

video_id string required

video_id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

delete_self_hosted_source

Delete Self Hosted Video Data Source. **Destructive** - requires confirm: true in safe mode.

Parameters

data_source_id string required

data_source_id (required)

video_id string required

video_id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

delete_video_source

Delete a Video Source. **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

confirm boolean optional

Set true to confirm (required in safe mode)

get_ad_timing

View Ad Timing.

Parameters

ad_timing_id string required

ad_timing_id (required)

data_source_id string required

data_source_id (required)

id string required

id (required)

get_app

View App.

Parameters

app_key string optional

app_key

page number optional

page

per_page number optional

per_page

get_device

View Device.

Parameters

id string required

id (required)

get_device_category

View Device Category.

Parameters

id string required

id (required)

get_encoder

View Encoder.

Parameters

encoder_name string required

encoder_name (required)

get_geoip

View GeoIP.

Parameters

ip_address string optional

ip_address

page number optional

page

per_page number optional

per_page

get_playlist_relationships

View Relationships.

Parameters

page number optional

page

parent_id string optional

parent_id

per_page number optional

per_page

get_segment

View Segment.

Parameters

id string required

id (required)

video_id string required

video_id (required)

get_self_hosted_source

View Self Hosted Video Data Source.

Parameters

data_source_id string required

data_source_id (required)

video_id string required

video_id (required)

get_site_user

View User.

Parameters

id string required

id (required)

get_target_rtmp

View Target RTMP entry.

Parameters

encoder_name string required

encoder_name (required)

target_rtmp_name string required

target_rtmp_name (required)

get_video_import

View Video Import.

Parameters

id string required

id (required)

get_video_source

View Video Source.

Parameters

id string required

id (required)

list_ad_timings

List Ad Timings.

Parameters

id string required

id (required)

list_ad_timings_for_data_source

List Ad Timings for Single Data Source.

Parameters

data_source_id string required

data_source_id (required)

id string required

id (required)

list_device_categories

List Devices Categories.

Parameters

page number optional

page

per_page number optional

per_page

title string optional

title

list_devices

List Devices.

Parameters

created_at string optional

created_at

id string optional

id

page number optional

page

per_page number optional

per_page

q string optional

q

title string optional

title

list_encoders

List Encoders.

Parameters

page number optional

page

per_page number optional

per_page

list_relative_playlist_videos

List Relative Playlist Videos.

Parameters

id string required

id (required)

after string optional

after

anchor_video_id string optional

anchor_video_id

before string optional

before

include_anchor string optional

include_anchor

sort string optional

sort

list_segments

List Segments.

Parameters

video_id string required

video_id (required)

list_self_hosted_sources

List Self Hosted Video Data Sources.

Parameters

video_id string required

video_id (required)

list_site_users

List Admin Users.

Parameters

email string optional

email

page number optional

page

per_page number optional

per_page

list_target_rtmp

List Targets RTMP entries.

Parameters

encoder_name string required

encoder_name (required)

list_video_imports

List Video Imports.

Parameters

active string optional

active

page number optional

page

per_page number optional

per_page

status string optional

status

type string optional

type

video_source_id string optional

video_source_id

list_video_sources

List Video Sources.

Parameters

page number optional

page

per_page number optional

per_page

type string optional

type

list_video_sources_for_video

List Video Sources for a Video.

Parameters

id string required

id (required)

remove_site_user

Remove an admin user from your property.. **Destructive** - requires confirm: true in safe mode.

Parameters

id string required

id (required)

body object optional

Request body fields

confirm boolean optional

Set true to confirm (required in safe mode)

remove_zobjects_from_video

Remove Zobject.

Parameters

id string required

id (required)

body object optional

Request body fields

start_encoder

Start an Encoder.

Parameters

encoder_name string required

encoder_name (required)

api_key string optional

api_key

body object optional

Request body fields

stop_encoder

Stop an Encoder. **Destructive** - requires confirm: true in safe mode.

Parameters

encoder_name string required

encoder_name (required)

body object optional

Request body fields

confirm boolean optional

Set true to confirm (required in safe mode)

update_ad_timing

Update Ad Timing.

Parameters

ad_timing_id string required

ad_timing_id (required)

data_source_id string required

data_source_id (required)

id string required

id (required)

body object optional

Request body fields

update_segment

Update Segment.

Parameters

id string required

id (required)

video_id string required

video_id (required)

body object optional

Request body fields

update_self_hosted_source

Update Self Hosted Video Data Source.

Parameters

data_source_id string required

data_source_id (required)

video_id string required

video_id (required)

body object optional

Request body fields

update_site_user

Update user.

Parameters

id string required

id (required)

body object optional

Request body fields

update_video_source

Update Video Source.

Parameters

id string required

id (required)

body object optional

Request body fields

🔑 TVE & Utilities

Adobe Primetime device authentication for pay-TV, the consumer OAuth token endpoint, direct uploads, the geo option lists used when building content rules, and the playlist carousel embed.

Example prompts:

  • "Preauthorize this device session for these resources"
  • "What states can I target in a content rule?"
  • "Get the carousel embed for this playlist"

12 Tools

list_states_for_country

List the state options for a country code, for building content rule profiles. Only US currently returns results.

Parameters

country string required

Country code, e.g. US (required)

list_cities_for_state

List the city options for a state code, for building content rule profiles.

Parameters

state string required

State code, e.g. CA (required)

create_upload

Create a direct upload slot.

Parameters

body object optional

Upload request fields

retrieve_consumer_access_token

Get a CONSUMER access token from the api.zype.com authorization server, via password or refresh_token grant. This is the end-user token, not the admin token issued by login.zype.com.

Parameters

client_id string required

Client ID (required)

client_secret string required

Client secret (required)

grant_type string required

Grant type (required)

"password" | "refresh_token"
linked_device_id string optional

Linked device ID (needs pin)

password string optional

Consumer password

pin string optional

Device pin

refresh_token string optional

Refresh token; required with grant_type=refresh_token

username string optional

Consumer email; required with grant_type=password

get_access_token_status

Inspect a consumer access token - whether it is valid and what it grants.

Parameters

access_token string required

The token (required)

adobe_authenticate

TVE: create a Zype consumer from an authenticated Adobe Primetime device session.

Parameters

device_session_id string required

Adobe device session ID (required)

adobe_validate_device_session

TVE: validate an Adobe Primetime device session.

Parameters

device_session_id string required

Adobe device session ID (required)

adobe_register_device

TVE: register a device for Adobe Primetime authentication.

Parameters

adobe_device_id string required

Adobe device ID (required)

device_info object optional

Device metadata

adobe_preauthorize

TVE: check which of the given resources a device session is preauthorized for.

Parameters

device_session_id string required

Adobe device session ID (required)

resource_ids array<string> required

Resource IDs (required)

adobe_media_token

TVE: obtain a short-lived media token for a resource.

Parameters

device_session_id string required

Adobe device session ID (required)

resource_id string required

Resource ID (required)

adobe_logout

TVE: end an Adobe Primetime device session. The device is signed out. **Destructive** - requires confirm: true in safe mode.

Parameters

device_session_id string required

Adobe device session ID (required)

confirm boolean optional

Set true to confirm (required in safe mode)

📋 Playlists

Organize content into playlists. Create curated collections, manage video ordering, and build dynamic content experiences.

Example prompts:

  • "Create a playlist called 'Best of 2025'"
  • "Add these 5 videos to the Featured playlist"
  • "Show me all videos in the Tutorials playlist"
  • "Remove the intro video from the Getting Started playlist"

8 Tools

list_playlists

List playlists from your Zype library with pagination and filters.

Parameters

active string optional

Filter by active status

"true" | "false" | "all"
friendly_title string optional

Filter by friendly title (slug)

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

q string optional

Search by keyword

sort string optional

Field to sort by

title string optional

Filter by title

get_playlist

Get detailed information about a specific playlist by its ID.

Parameters

playlist_id string required

The unique ID of the playlist

create_playlist

Create a new playlist in Zype.

Parameters

title string required

Title of the playlist (required)

active boolean optional

Whether the playlist is active (default: true)

categories array<object> optional

Assign category values. Omit `id` to add a new entry; pass the existing entry id (from get_playlist) to update an existing one.

description string optional

Description of the playlist

friendly_title string optional

URL-friendly title (slug)

match_type string optional

For category playlists: match all or any of the specified category values (default: all)

"all" | "any"
parent_id string optional

Parent playlist ID for nested playlists

playlist_type string optional

Playlist type: manual (hand-picked videos) or category (dynamic playlist based on category values)

"manual" | "category"
priority number optional

Priority for ordering

update_playlist

Update an existing playlist's metadata.

Parameters

playlist_id string required

The unique ID of the playlist to update (required)

active boolean optional

Set active status

categories array<object> optional

Update category values. Omit `id` to add a new entry; pass the existing entry id (from get_playlist) to update an existing one.

description string optional

New description

friendly_title string optional

New URL-friendly title

match_type string optional

For category playlists: match all or any of the specified category values

"all" | "any"
playlist_type string optional

Change playlist type: manual or category

"manual" | "category"
priority number optional

New priority

title string optional

New title

delete_playlist

Permanently delete a playlist from Zype. This action cannot be undone.

Parameters

playlist_id string required

The unique ID of the playlist to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

list_playlist_videos

List all videos in a specific playlist.

Parameters

playlist_id string required

The unique ID of the playlist (required)

page number optional

Page number

per_page number optional

Results per page

add_videos_to_playlist

Add one or more videos to a playlist.

Parameters

playlist_id string required

The unique ID of the playlist (required)

video_ids array<string> required

Array of video IDs to add (required)

remove_videos_from_playlist

Remove one or more videos from a playlist.

Parameters

playlist_id string required

The unique ID of the playlist (required)

video_ids array<string> required

Array of video IDs to remove (required)

🏷️ Categories

Organize videos with custom categories like Genre, Premium status, or any attribute. Categories enable powerful filtering and content organization.

Example prompts:

  • "List all categories and their values"
  • "Create a new category called 'Content Type' with values Tutorial, Demo, Interview"
  • "What categories can I filter videos by?"

5 Tools

list_categories

List all categories in your Zype library. **Call this FIRST when filtering videos by category.**

More details
Categories organize videos by attributes like Genre, Premium status, YouTube Channel, etc.
Each category has a title and list of possible values.

**Workflow for category-based video queries:**
1. Call list_categories to see available category titles and their values
2. Use list_videos with category filter: {"category": {"CategoryTitle": "value"}}

Example: To find "Saturday Night Live" videos:
1. list_categories → shows "YouTube Channel" category with "Saturday Night Live" as a value
2. list_videos with {"category": {"YouTube Channel": "Saturday Night Live"}}

Parameters

friendly_title string optional

Filter by friendly title (slug)

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

sort string optional

Field to sort by

title string optional

Filter by title

get_category

Get detailed information about a specific category by its ID.

Parameters

category_id string required

The unique ID of the category

create_category

Create a new category in Zype. Categories help organize videos by attributes like genre, season, etc.

Parameters

title string required

Title of the category (required)

friendly_title string optional

URL-friendly title (slug)

values array<string> optional

Array of possible values for this category

update_category

Update an existing category.

Parameters

category_id string required

The unique ID of the category to update (required)

friendly_title string optional

New URL-friendly title

title string optional

New title

values array<string> optional

New array of possible values

delete_category

Permanently delete a category from Zype. This action cannot be undone.

Parameters

category_id string required

The unique ID of the category to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

💬 Subtitles

Manage subtitles and captions for accessibility. Create, update, and organize subtitle files for your videos.

Example prompts:

  • "List all subtitles for video abc123"
  • "Add Spanish subtitles to my product video"
  • "Create a subtitle playlist for HLS streaming"

7 Tools

list_subtitles

List all subtitles for a specific video.

Parameters

video_id string required

The video ID to list subtitles for (required)

page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

get_subtitle

Get detailed information about a specific subtitle.

Parameters

subtitle_id string required

The unique ID of the subtitle (required)

video_id string required

The video ID (required)

create_subtitle

Create/add a new subtitle for a video.

Parameters

language string required

Language code, e.g., "en", "es", "fr" (required)

video_id string required

The video ID to add subtitle to (required)

active boolean optional

Whether the subtitle is active (default: true)

url string optional

URL to the subtitle file (SRT, VTT)

update_subtitle

Update an existing subtitle.

Parameters

subtitle_id string required

The unique ID of the subtitle to update (required)

video_id string required

The video ID (required)

active boolean optional

Set active status

language string optional

New language code

url string optional

New URL to the subtitle file

create_subtitle_playlist

Create a subtitle playlist for HLS streaming. This generates segmented subtitle files.

Parameters

subtitle_id string required

The subtitle ID (required)

video_id string required

The video ID (required)

delete_subtitle_playlist

Delete a subtitle playlist.

Parameters

subtitle_id string required

The subtitle ID (required)

video_id string required

The video ID (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

delete_subtitle

Permanently delete a subtitle from a video. This action cannot be undone.

Parameters

subtitle_id string required

The subtitle ID to delete (required)

video_id string required

The video ID (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

📊 Analytics

Query performance data including plays, viewers, watch time, and revenue. Use analytics to make data-driven content decisions.

Example prompts:

  • "What are my top 10 most-watched videos this month?"
  • "Show viewer trends for the last 30 days"
  • "Which videos have the highest engagement?"
  • "Show subscription revenue by month"

13 Tools

get_plays

Get video play counts - how many times content was played.

More details
USAGE:
- By video: group_by=["video_id"] or group_by=["video_id","video_title"]
- By country: group_by=["country"]
- By platform: group_by=["platform"]
- Daily trend: interval="day"
- For specific video: video_id="..."

SORTING: Use sort_by (e.g., "day_desc", "video_id_asc"). NOTE: Cannot sort by play count - for "top N videos by plays", fetch with group_by=["video_id"] and sort results client-side.

Data limited to last 90 days. Defaults to last 2 weeks if no dates specified.

Parameters

country string optional

Filter by country code (e.g., "US", "GB", "CA")

group_by array<string> optional

Group results by fields. Options: video_id, video_title, playlist_id, playlist_name, platform, consumer_id, country, domain, app_id, app_name, content_type

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

platform string optional

Filter by platform (e.g., "ios", "android", "web", "roku")

playlist_id string optional

Filter by playlist ID

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by specific video ID

get_viewers

Get unique viewer counts over time.

More details
USAGE:
- By video: group_by=["video_id","video_title"]
- By country: group_by=["country"]
- Daily trend: interval="day"

SORTING: Use sort_by (e.g., "day_desc"). Cannot sort by viewer count.

Data limited to last 90 days.

Parameters

country string optional

Filter by country code (e.g., "US", "GB", "CA")

group_by array<string> optional

Group results by fields. Options: video_id, video_title, playlist_id, playlist_name, platform, consumer_id, country, domain, app_id, app_name, content_type

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

platform string optional

Filter by platform (e.g., "ios", "android", "web", "roku")

playlist_id string optional

Filter by playlist ID

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by specific video ID

get_hours_watched

Get total hours of content watched.

More details
USAGE:
- By video: group_by=["video_id","video_title"]
- By platform: group_by=["platform"]
- Daily trend: interval="day"

SORTING: Use sort_by (e.g., "day_desc"). Cannot sort by hours watched.

Data limited to last 90 days.

Parameters

country string optional

Filter by country code (e.g., "US", "GB", "CA")

group_by array<string> optional

Group results by fields. Options: video_id, video_title, playlist_id, playlist_name, platform, consumer_id, country, domain, app_id, app_name, content_type

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

platform string optional

Filter by platform (e.g., "ios", "android", "web", "roku")

playlist_id string optional

Filter by playlist ID

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by specific video ID

get_view_time

Get average view time and completion metrics.

More details
USAGE:
- By video: group_by=["video_id","video_title"]
- By platform: group_by=["platform"]
- Daily trend: interval="day"

SORTING: Use sort_by (e.g., "day_desc"). Cannot sort by view time value.

Data limited to last 90 days.

Parameters

country string optional

Filter by country code (e.g., "US", "GB", "CA")

group_by array<string> optional

Group results by fields. Options: video_id, video_title, playlist_id, playlist_name, platform, consumer_id, country, domain, app_id, app_name, content_type

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

platform string optional

Filter by platform (e.g., "ios", "android", "web", "roku")

playlist_id string optional

Filter by playlist ID

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by specific video ID

list_stream_hours

Get total streaming/delivery hours across the platform.

More details
USAGE:
- By video: group_by=["video_id","video_title"]
- Daily trend: interval="day"

Data limited to last 90 days.

Parameters

country string optional

Filter by country code

group_by array<string> optional

Group by fields: video_id, video_title, country, platform

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

platform string optional

Filter by platform

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

list_player_requests

Get video player load/request counts.

More details
USAGE:
- By video: group_by=["video_id","video_title"]
- Daily trend: interval="day"
- By platform: group_by=["platform"]

Data limited to last 90 days.

Parameters

country string optional

Filter by country code

group_by array<string> optional

Group by fields: video_id, video_title, country, platform

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

platform string optional

Filter by platform

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

list_new_subscriptions

Get new subscription sign-up counts.

More details
USAGE:
- By plan: group_by=["plan_id","plan_name"]
- Daily trend: interval="day"
- By country: group_by=["country"]

SORTING: Cannot sort by subscription count.

Data limited to last 90 days.

Parameters

country string optional

Filter by country code (e.g., "US", "GB")

group_by array<string> optional

Group results by fields. Options: plan_id, plan_name, country, platform

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

plan_id string optional

Filter by subscription plan ID

platform string optional

Filter by platform

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

list_subscription_revenue

Get subscription revenue data.

More details
USAGE:
- By plan: group_by=["plan_id","plan_name"]
- Daily trend: interval="day"
- By country: group_by=["country"]

SORTING: Cannot sort by revenue amount.

Data limited to last 90 days.

Parameters

country string optional

Filter by country code (e.g., "US", "GB")

group_by array<string> optional

Group results by fields. Options: plan_id, plan_name, country, platform

interval string optional

Time interval for grouping data (default: day)

"hour" | "day" | "month"
limit number optional

Max results to return (default: 200, max: 500)

offset number optional

Offset for pagination

plan_id string optional

Filter by subscription plan ID

platform string optional

Filter by platform

sort_by string optional

Sort by field+direction. Default: day_desc. NOTE: Cannot sort by metric value - for top N by plays/views, fetch all and sort client-side.

"day_desc" | "day_asc" | "hour_desc" | "hour_asc" | "month_desc" | "month_asc" | "video_id_desc" | "video_id_asc" | "video_title_desc" | "video_title_asc" | "platform_desc" | "platform_asc" | "country_desc" | "country_asc" | "playlist_id_desc" | "playlist_id_asc"
start_date_gte string optional

Start date filter (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

End date filter (YYYY-MM-DD). Defaults to today.

list_playout_hours

Playout channel hours requested over a date range. Use to track Playout Channel delivery volume.

Parameters

group_by array<string> optional

Group by fields, e.g. playout_channel_id

interval string optional

Time bucket, e.g. day, month

limit number optional
offset number optional
start_date_gte string optional

Start date (YYYY-MM-DD). Defaults to 14 days ago.

start_date_lte string optional

End date (YYYY-MM-DD). Defaults to today.

get_platform_metrics

Aggregate platform metrics over a date range (Platform Dynamics).

Parameters

group_by array<string> optional
interval string optional
limit number optional
offset number optional
start_date_gte string optional

Start date (YYYY-MM-DD)

start_date_lte string optional

End date (YYYY-MM-DD)

get_consumer_metrics

Consumer counts and activity over a date range (Platform Dynamics).

Parameters

group_by array<string> optional

e.g. platform, country

interval string optional
limit number optional
offset number optional
start_date_gte string optional

Start date (YYYY-MM-DD)

start_date_lte string optional

End date (YYYY-MM-DD)

list_new_transactions

New transactions (purchases, rentals, passes) over a date range.

Parameters

group_by array<string> optional
interval string optional
limit number optional
offset number optional
playlist_id string optional
start_date_gte string optional

Start date (YYYY-MM-DD)

start_date_lte string optional

End date (YYYY-MM-DD)

video_id string optional
list_subscription_events

Subscription lifecycle events (starts, cancels, renewals) over a date range.

Parameters

group_by array<string> optional
interval string optional
limit number optional
offset number optional
plan_id string optional
start_date_gte string optional

Start date (YYYY-MM-DD)

start_date_lte string optional

End date (YYYY-MM-DD)

💰 Monetization

Manage subscriptions, plans, transactions, redemption codes, ad tags, and revenue models. Complete control over your monetization strategy.

Example prompts:

  • "List all active subscription plans"
  • "Show recent transactions"
  • "How many new subscriptions this month?"
  • "List all ad tags"

33 Tools

list_subscriptions

List subscriptions with optional filtering by plan, consumer, or payment provider.

Parameters

consumer_id string optional

Filter by consumer ID

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

payment_provider string optional

Filter by payment provider

"stripe" | "braintree" | "recurly" | "redemption" | "third_party" | "amazon_fire" | "google_play" | "itunes" | "samsung" | "tizen" | "roku"
per_page number optional

Results per page (default: 10, max: 500)

plan_id string optional

Filter by plan ID

q string optional

Search by keyword

sort string optional

Field to sort by

get_subscription

Get detailed information about a specific subscription.

Parameters

subscription_id string required

The subscription ID

create_subscription

Create a new subscription for a consumer.

Parameters

consumer_id string required

ID of the consumer

plan_id string required

ID of the subscription plan

coupon_code string optional

Coupon code to apply

trial_period_days number optional

Trial period in days

cancel_subscription

Cancel an existing subscription.

Parameters

subscription_id string required

The subscription ID to cancel

list_plans

List subscription plans with optional filtering.

Parameters

active boolean optional

Filter by active status

interval string optional

Filter by billing interval

"month" | "year"
order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page

q string optional

Search by keyword

sort string optional

Field to sort by

get_plan

Get detailed information about a specific subscription plan.

Parameters

plan_id string required

The plan ID

create_plan

Create a new subscription plan.

Parameters

amount string required

Plan price (e.g., "9.99")

interval string required

Billing interval

"month" | "year"
name string required

Plan name

active boolean optional

Whether the plan is active

currency string optional

Currency code (default: USD)

description string optional

Plan description

interval_count number optional

Number of intervals (default: 1)

trial_period_days number optional

Trial period in days

update_plan

Update an existing subscription plan.

Parameters

plan_id string required

The plan ID to update

active boolean optional

Set active status

amount string optional

New price

description string optional

New description

name string optional

New plan name

delete_plan

Delete a subscription plan.

Parameters

plan_id string required

The plan ID to delete

list_transactions

List transactions with optional filtering by consumer, video, or type.

Parameters

consumer_id string optional

Filter by consumer ID

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page

playlist_id string optional

Filter by playlist ID

q string optional

Search by keyword

sort string optional

Field to sort by

transaction_type string optional

Filter by transaction type

"purchase" | "rental" | "pass"
video_id string optional

Filter by video ID

get_transaction

Get detailed information about a specific transaction.

Parameters

transaction_id string required

The transaction ID

create_transaction

Create a new transaction (purchase, rental, or pass).

Parameters

amount string required

Transaction amount (e.g., "4.99")

consumer_id string required

ID of the consumer

transaction_type string required

Type of transaction

"purchase" | "rental" | "pass"
currency string optional

Currency code (default: USD)

expires_at string optional

Expiration date for rentals (ISO8601)

playlist_id string optional

Playlist ID for playlist transactions

video_id string optional

Video ID for video transactions

delete_redemption_code

Permanently delete a redemption code.

Parameters

code_id string required

Code ID or the code string (required)

confirm boolean optional

Set true to confirm (required in safe mode)

bulk_create_redemption_codes

Generate many redemption codes at once via /redemption_codes/bulk_create.

Parameters

expiration_date string required

Expiration date e.g. 2027-01-15 (required)

code string optional

Your own code; omit to auto-generate

plan_id string optional
playlist_id string optional
quantity number optional

How many to generate

video_id string optional
redeem_redemption_code

Redeem an available redemption code, granting the consumer its entitlement.

Parameters

code string required

The code to redeem (required)

add_playlists_to_plan

Add playlists to a tiered subscription plan.

Parameters

plan_id string required

The plan ID (required)

playlist_ids array<string> required

Playlist IDs to add (required)

remove_playlists_from_plan

Remove playlists from a subscription plan.

Parameters

plan_id string required

The plan ID (required)

playlist_ids array<string> required

Playlist IDs to remove (required)

reactivate_subscription

Reactivate a previously cancelled subscription.

Parameters

subscription_id string required

The subscription ID (required)

update_subscription

Update a subscription - change its plan, status, or expiry.

Parameters

subscription_id string required

The subscription ID (required)

expires_at string optional
plan_id string optional
status string optional
delete_subscription

Permanently DELETE a subscription record. This is not the same as cancelling - use cancel_subscription to cancel and keep the record.

Parameters

subscription_id string required

The subscription ID (required)

confirm boolean optional

Set true to confirm (required in safe mode)

update_transaction

Update a transaction - amount, expiry, or status.

Parameters

transaction_id string required

The transaction ID (required)

amount string optional
expires_at string optional
status string optional
delete_transaction

Delete a transaction record.

Parameters

transaction_id string required

The transaction ID (required)

confirm boolean optional

Set true to confirm (required in safe mode)

list_redemption_codes

List redemption codes with optional filtering by plan, video, or redemption status.

Parameters

expired boolean optional

Filter by expired status

page number optional

Page number (default: 1)

per_page number optional

Results per page

plan_id string optional

Filter by plan ID

playlist_id string optional

Filter by playlist ID

redeemed boolean optional

Filter by redeemed status

video_id string optional

Filter by video ID

get_redemption_code

Get detailed information about a specific redemption code.

Parameters

code_id string required

The redemption code ID

create_redemption_code

Generate new redemption codes for subscriptions, videos, playlists, or passes.

Parameters

content_type string required

Type of content the code unlocks

"subscription" | "video" | "playlist" | "pass"
expiration_date string optional

Expiration date (YYYY-MM-DD)

plan_id string optional

Plan ID for subscription codes

playlist_id string optional

Playlist ID for playlist codes

quantity number optional

Number of codes to generate (default: 1, max: 100)

video_id string optional

Video ID for video codes

update_redemption_code

Update an existing redemption code - change its active status, expiration, or the content it unlocks.

Parameters

code_id string required

The redemption code ID, or the code string itself (required)

active boolean optional

Set active status

expiration_date string optional

New expiration date (YYYY-MM-DD)

plan_id string optional

New plan ID for subscription codes

playlist_id string optional

New playlist ID for playlist codes

video_id string optional

New video ID for video codes

list_ad_tags

List ad tags (VAST/VMAP) configured for your account.

Parameters

active boolean optional

Filter by active status

page number optional

Page number (default: 1)

per_page number optional

Results per page

get_ad_tag

Get detailed information about a specific ad tag.

Parameters

ad_tag_id string required

The ad tag ID

create_ad_tag

Create a new VAST/VMAP ad tag.

Parameters

name string required

Ad tag name

tag string required

The VAST/VMAP ad tag URL

active boolean optional

Whether the ad tag is active (default: true)

scope string optional

Ad tag scope

"library" | "video" | "playlist"
vmap boolean optional

Whether this is a VMAP tag

update_ad_tag

Update an existing ad tag.

Parameters

ad_tag_id string required

The ad tag ID to update

active boolean optional

Set active status

name string optional

New name

tag string optional

New ad tag URL

delete_ad_tag

Delete an ad tag.

Parameters

ad_tag_id string required

The ad tag ID to delete

list_revenue_models

List available revenue models (AVOD, SVOD, TVOD, etc.).

Parameters

page number optional

Page number (default: 1)

per_page number optional

Results per page

get_revenue_model

Get detailed information about a specific revenue model.

Parameters

revenue_model_id string required

The revenue model ID

🧩 Zobjects

Custom metadata objects for advanced content modeling. Create custom types like Actors, Directors, Series, or any structured data and associate them with videos.

Example prompts:

  • "List all zobject types"
  • "Create a new Actor zobject for Tom Hanks"
  • "Associate the Director zobject with these videos"
  • "Find all videos linked to the Marvel zobject"

16 Tools

list_zobject_types

List all zobject types in your Zype library. Zobject types define custom metadata schemas (e.g., actors, directors, genres).

Parameters

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

q string optional

Filter by keyword

sort string optional

Field to sort by

get_zobject_type

Get detailed information about a specific zobject type, including its custom attributes.

Parameters

zobject_type_id string required

The unique ID of the zobject type

create_zobject_type

Create a new zobject type (custom metadata schema). Define custom attributes for your content metadata like actors, directors, etc.

Parameters

title string required

Title of the zobject type (must be unique, required)

description string optional

Description of the zobject type

playlists_enabled boolean optional

Allow associating playlists with zobjects of this type (default: false)

videos_enabled boolean optional

Allow associating videos with zobjects of this type (default: true)

zobject_attributes_attributes array<object> optional

Custom attributes/fields for this zobject type

update_zobject_type

Update an existing zobject type.

Parameters

zobject_type_id string required

The unique ID of the zobject type to update (required)

description string optional

New description

playlists_enabled boolean optional

Allow associating playlists

title string optional

New title

videos_enabled boolean optional

Allow associating videos

zobject_attributes_attributes array<object> optional

Updated custom attributes (replaces existing)

delete_zobject_type

Permanently delete a zobject type. This action cannot be undone and may affect associated zobjects.

Parameters

zobject_type_id string required

The unique ID of the zobject type to delete (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

list_zobjects

List zobjects (custom metadata instances) with optional filtering by type. Returns full API response including all custom attributes defined on the zobject type (e.g., pictures, keywords, stadium info for teams, biography for actors). Custom attributes are returned as top-level fields. Examples: list all actors, directors, teams.

Parameters

active boolean optional

Filter by active status

order string optional

Sort order

"asc" | "desc"
page number optional

Page number (default: 1)

per_page number optional

Results per page (default: 10, max: 500)

q string optional

Search by keyword

sort string optional

Field to sort by

zobject_type string optional

Filter by zobject type title (e.g., "actor", "director", "teams")

zobject_type_id string optional

Filter by zobject type ID

get_zobject

Get detailed information about a specific zobject, including all custom attributes, associated videos and playlists. Returns full API response with custom attributes as top-level fields (e.g., pictures array, keywords, stadium_name, team_abbreviation, biography, etc. depending on zobject type schema).

Parameters

zobject_id string required

The unique ID of the zobject

zobject_type string required

The zobject type title (e.g., "actor", "director", "teams")

create_zobject

Create a new zobject (custom metadata instance). Must specify which zobject_type it belongs to.

Parameters

title string required

Title of the zobject (required)

zobject_type_id string required

ID of the zobject type this zobject belongs to (required)

active boolean optional

Whether the zobject is active (default: true)

custom object optional

Custom attributes as key-value pairs

description string optional

Description

friendly_title string optional

URL-friendly title (slug)

playlist_ids array<string> optional

Array of playlist IDs to associate

video_ids array<string> optional

Array of video IDs to associate

update_zobject

Update an existing zobject. Only provide the fields you want to change.

Parameters

zobject_id string required

The unique ID of the zobject to update (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

active boolean optional

Set active status

custom object optional

Update custom attributes

description string optional

New description

friendly_title string optional

New URL-friendly title

playlist_ids array<string> optional

Replace playlist associations

title string optional

New title

video_ids array<string> optional

Replace video associations

delete_zobject

Permanently delete a zobject. This action cannot be undone.

Parameters

zobject_id string required

The unique ID of the zobject to delete (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

confirm boolean optional

Set to true to confirm deletion (required in safe mode)

add_videos_to_zobject

Add one or more videos to a zobject (e.g., associate videos with an actor).

Parameters

video_ids array<string> required

Array of video IDs to add (required)

zobject_id string required

The unique ID of the zobject (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

remove_videos_from_zobject

Remove one or more videos from a zobject.

Parameters

video_ids array<string> required

Array of video IDs to remove (required)

zobject_id string required

The unique ID of the zobject (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

get_zobject_videos

List all videos associated with a zobject.

Parameters

zobject_id string required

The unique ID of the zobject (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

page number optional

Page number (default: 1)

per_page number optional

Results per page

add_playlists_to_zobject

Add one or more playlists to a zobject.

Parameters

playlist_ids array<string> required

Array of playlist IDs to add (required)

zobject_id string required

The unique ID of the zobject (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

remove_playlists_from_zobject

Remove one or more playlists from a zobject.

Parameters

playlist_ids array<string> required

Array of playlist IDs to remove (required)

zobject_id string required

The unique ID of the zobject (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

get_zobject_playlists

List all playlists associated with a zobject.

Parameters

zobject_id string required

The unique ID of the zobject (required)

zobject_type string required

The zobject type, e.g., "actor", "director" (required)

page number optional

Page number (default: 1)

per_page number optional

Results per page