Zype API Reference Index

The password grant flow allows you to pass in a user’s username (email address) and password to get an access token in return.

This requests revokes an access token, removing the session from the active logins list.

Add one or multiple Zobjects to your video

Apply the AI-generated metadata from a session to a video

Generate AI metadata for multiple videos in bulk

Add a data source to a self-hosted video

Create new Ad Timing on Data Source

Generate AI metadata for a video

Create and add a Self Hosted Video to your library

Add a video to your library

Destroy a single Ad Timing

Download the original source file for your video

Retrieve a specific AI metadata session for a video

List Ad Timings for each Ad-Timeable Data Source

List Ad Timings for single Ad-Timeable Data Source

Retrieve a list of playlists from your library

Returns a windowed set of videos from a playlist relative to the anchor video

Retrieve a list of self-hosted video data sources

List possible translation languages

Retrieve a list of videos from your library

Retrieve a list of videos from your library

Remove one or multiple Zobjects from your video

Retrieve all videos linked with a Zobject

Update a single Ad Timing

Update a single video from your library

Retrieve a single Ad Timing from your Video/Data Source

Retrieve a single transcription or translation

Retrieve a single video from your library

Retrieve a single video from your library

Only MRSS video sources may be created via the API at this time.

Attach a video import as a Source to a video in the library

Import a video from a 3rd party source url

Add playlists to a Zobject

This operation is only used for Tiered Subscription Plans (i.e., plans that have entitle_type=tiered). This operation is used to determine which videos belonging to playlists in your library should be accessible to each Tiered Subscription Plan. Once you add a playlist to a Tiered Plan, any child playlists (and videos belonging to those child playlists) will also inherit the subscription requirements from that Tiered Plan. Note: This operation will only add the specified Playlists to the Tiered Plan, it won’t remove any of the existing Playlists associated to it. Note: If a video is currently monetized with a purchase, rental, or pass plan, and your property does NOT support multiple monetization, then adding that video to a playlist within a tiered subscription will disable the existing purchase, rental, or pass plan paywall and switch the paywall monetization on the video to the tiered subscription plan.

Add videos to a manual playlist

Create a new Playlist

Retrieve a list of playlists from your library

Remove playlists from a Zobject

Note: This operation will only remove the specified Playlists to the Plan, if they exist.

Remove videos in a playlist

Retrieve all playlists linked with a Zobject

Retrieve a single playlist from your library

The full URL will look like https://player.zype.com/playlists/[playlist_id]/carousel.[format]. The format for the player response must be one of Iframes, JavaScript (Example: html, js). Use a consumer's access token or your site's API/App/Player keys to authenticate this call.

Returns a list of playlists and its relationships

Add an admin user to your property

Retrieve a list of administrative users on your property.

Admin users are global, and can have access to multiple zype properties. This method does not delete the user, it only removes it from your property.

Update a single user on your property

Retrieve a single admin user from your site

Use this endpoint to archive your live event. Only perform this action once your event has ended.

Create a new live encoder

Delete a live encoder

Retrieve a list of live encoders from your account

Retrieve a list of encoders from your account

Retrieve a list of target rtmp entries from your encoder

Use this endpoint to start broadcasting your live event.

Start broadcasting with a live encoder. This will schedule the RTMP input to the timeline, publish the draft schedule, and start the encoder.

Use this endpoint to end broadcasting your live event.

Stop broadcasting with a live encoder

Synchronize the encoder data with the external streaming provider. This fetches the latest encoder state and updates the local configuration.

Update an existing live encoder

Retrieve details of a specific live encoder

Resets all ad timings associated with the asset (deletes the ones created in Playout and resets the ones coming from CMS)

Retrieve a list of ads from your library

Retrieve a list of ads from your library

Retrieve a single ad from your library

Retrieve a single bumper from your library

Add a new graphic to your library

Delete a graphic from your library

Retrieve an upload

Use this endpoint to get the published JSON EPG

Get graphics in your library

Sync the automated graphic insertions configured for the channel on every future track item (performed asynchronously).

Update a graphic asset in your library

This endpoint provides access to EPG data in XMLTV format. XMLTV is a standardized XML-based format for exchanging TV listings and EPG data. This endpoint allows you to retrieve comprehensive and structured information about scheduled TV programs, including program names, descriptions, start times, end times, channels, and more. The response will contain the EPG data in XMLTV format, which you can parse and use to display TV program listings in your application.

Retrieve a single graphic from your library

Returns automated graphics associated with the given track item id

Add videos to a Zobject

Retrieve the site Zobjects. Appart from the fields listed below, you can also filter by custom attributes. Format: `key=value`. Example: if you have a custom attribute `psl_id` you can filter by `psl_id=1234`

Remove videos from a Zobject

Create a custom content rule group for the current site.

Create a content rule profile for the current site.

Delete a content rule group from the current site.

Delete a content rule profile from the current site.

Retrieve custom content rule groups (e.g. country groupings) for the current site.

Retrieve the content rule profiles for the current site.

Retrieve the platform global content rule group catalog.

Update a content rule group for the current site.

Update a content rule profile for the current site.

Retrieve a single content rule group from the current site.

Retrieve a single content rule profile from the current site.

Retrieve a single global content rule group by id from the platform catalog. Read-only. Same response shape as custom content rule groups.

The full URL will look like https://player.zype.com/embed/[video_id].[format]. The format for the player response must be one of Iframes, JavaScript or JSON players depending on device capabilities (Example: html, js, json). Use a consumer's access token or your site's API/App/Player keys to authenticate this call.

Upload a video to your library

Return the available city options for a state code.

Return the available state options for a country code. The current implementation only returns results for `US`.

Retrieve the GeoIP object for a specific IP Address

Given the device session ID, returned in the response of the Register Adobe Device Session endpoint, this endpoint creates a Zype's Consumer.

Remove the Adobe Device Session from Zype and Adobe's authn and authz token.

Obtain a short-lived media token for Adobe TVE authentication.

Register the Adobe Session device info in Zype

Consumer Parental Access code will be reset, and email is sent to the consumer initiating a reset parental access code flow.

This endpoint retrieves the list of resources that have been preauthorized for the specified device session.

Indicates whether the device has an unexpired authentication token.

The hours watched endpoint provides insights on the amount of hours contet has been watched. It returns data on how many hours content has been watched, which can be filtered by various parameters such as date range, content type, and more. This is useful for understanding viewer engagement and content performance.

This endpoint will return consumer analytics data for your property.

This endpoint returns analytics data showing how your OTT business changes over time.

This endpoint will return new subscription analytics data for your property.

This endpoint will return new transaction analytics data for your property.

This endpoint will return Player Request analytics data for your property.

This endpoint to retrieve hours requested data for Playout Channels. This allows customers who are distributing Playout Channels where Zype supports the delivery to measure and track detailed information related to their Playout Channel hours requested.

This endpoint will retrieve stream hour data for your property.

This endpoint will counts of subscription creations, trials started, pauses, and cancellations for your property

This endpoint will return subscription revenue data for your property, optionally grouped by day, for the date range supplied in filters[start_date] and filters[end_date]. The aggregate or daily data will be rendered as: "2021-03-01": { currency_code1: amount1, currency_code2: amount2 } where currency_code is a standard ISO 4217 code (USD, CAD, etc), and amount is a number representing the quantity of the given currency.

The plays endpoint provides insights on the number of times content has been played. It returns data on how many times content has been played, which can be filtered by various parameters such as date range, content type, and more. This is useful for understanding viewer engagement and content performance.

The view time endpoint provides insights on the average amount of time content has been watched. It returns data on the average amount of time content has been watched, which can be filtered by various parameters such as date range, content type, and more. This is useful for understanding viewer engagement and content performance.

The viewers endpoint provides insights on how many unique viewers have watched content. It returns data on how many unique viewers have watched content, which can be filtered by various parameters such as date range, content type, and more. This is useful for understanding viewer engagement and content performance.