← Back to Home

Tool Reference

Complete reference for all 72 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: [{"title": "Premium", "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 update categories: provide categories array with {title, value} objects
- 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 category update: {"video_id": "...", "categories": [{"title": "Premium", "value": ["true"]}]}

Parameters

video_id string required

Video ID to update (required)

active boolean optional

Active status

categories array<object> optional

Category assignments

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 a download URL for a video. Returns a temporary URL that can be used to download the video file.

Parameters

video_id string required

The unique ID of the video (required)

📋 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

description string optional

Description of the playlist

friendly_title string optional

URL-friendly title (slug)

parent_id string optional

Parent playlist ID for nested playlists

playlist_type string optional

Playlist type (default: manual)

"manual" | "automated"
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

description string optional

New description

friendly_title string optional

New URL-friendly title

playlist_type string optional

Change playlist type

"manual" | "automated"
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"

8 Tools

get_plays

Get play counts for videos. Shows how many times content has been played. Useful for understanding viewer engagement. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields (e.g., ["video_id", "video_title"])

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

playlist_id string optional

Filter by playlist ID

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

get_viewers

Get viewer counts. Shows unique viewers over time. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

playlist_id string optional

Filter by playlist ID

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

get_hours_watched

Get total hours watched. Shows how much time viewers spent watching content. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

playlist_id string optional

Filter by playlist ID

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

get_view_time

Get view time analytics. Shows average view time and completion rates. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

playlist_id string optional

Filter by playlist ID

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

list_stream_hours

Get stream hours data. Shows total streaming time across the platform. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

list_player_requests

Get player request counts. Shows how many times the video player was loaded. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

video_id string optional

Filter by video ID

list_new_subscriptions

Get new subscription counts. Shows how many new subscriptions were created. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

plan_id string optional

Filter by plan ID

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

list_subscription_revenue

Get subscription revenue data. Shows revenue from subscriptions over time. Data limited to last 90 days.

Parameters

group_by array<string> optional

Group by fields

interval string optional

Group by time interval (default: day)

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

Limit results (default: 200, max: 500)

offset number optional

Offset for pagination

plan_id string optional

Filter by plan ID

start_date_gte string optional

Filter: start date >= (YYYY-MM-DD). Max 90 days ago. Defaults to 2 weeks ago.

start_date_lte string optional

Filter: start date <= (YYYY-MM-DD). Defaults to today.

💰 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"

22 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

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_codes

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

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. Examples: list all actors, directors for a genre.

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")

zobject_type_id string optional

Filter by zobject type ID

get_zobject

Get detailed information about a specific zobject, including associated videos and playlists.

Parameters

zobject_id string required

The unique ID of the zobject

zobject_type string required

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

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