How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zype Platform API

The core Zype content API: videos, playlists, categories, subtitles and subtitle playlists, transcriptions and translations, AI metadata suggestions, segments, program guides, video imports and sources, devices, GeoIP, admin users and legacy live encoders. 88 operations.

Zype Platform API is one of 15 APIs that Zype publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Video, Content Management, Metadata, Transcription, and Playlists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 88 operations across 59 paths, organized into 16 resource areas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.zype.com/.

88 operations 59 paths 0 schemas 9 DELETE43 GET20 POST16 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.zype.com/
Authentication
API Key, HTTP Bearer
Resource Areas
16

Authentication & Security 2

Zype Platform API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). It accepts HTTP bearer tokens (OAuth access token) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth access token of the consumer

Paths & Operations 88

Across 59 paths, the API surfaces 88 operations — 9 DELETE, 43 GET, 20 POST, 16 PUT. They span 16 resource areas, including Videos, Playlists, Categories, Apps, Subtitles, Subtitle Playlists, Program Guides, Devices, and 8 more. Each is listed below with its method, path, parameters, and response codes.

Videos 25
GET
/videos
List Videos
listVideos 33 params → 200422
POST
/videos
Create Video
createVideo body → 201422
GET
/videos/{id}
View Video
getVideo 5 params → 200404
PUT
/videos/{id}
Update Video
updateVideo 1 param body → 200404422
DELETE
/videos/{id}
Delete Video
deleteVideo 1 param → 204404
POST
/videos/ai_metadata/suggestions
Bulk Create AI Metadata
bulkCreateAIMetadata body → 200422
POST
/videos/{id}/ai_metadata/suggestions
Create AI Metadata
createAIMetadata 1 param body → 200404422
GET
/videos/{id}/ai_metadata/suggestions/{session_id}
Get AI Metadata
getAIMetadata 2 params → 200404
POST
/videos/{id}/ai_metadata/suggestions/{session_id}/apply
Apply AI Metadata
applyAIMetadata 2 params → 200404422
PUT
/videos/{id}/add_zobjects
Add Zobject(s)
addZobject 1 param body → 200404422
PUT
/videos/{id}/remove_zobjects
Remove Zobject
removeZobject 1 param body → 200404422
GET
/videos/{id}/download
Download Video
downloadVideo 1 param → 200404422
GET
/videos/{id}/ad_timings
List Ad Timings
listAdTimings 1 param → 200404
GET
/videos/{id}/data_sources/{data_source_id}/ad_timings
List Ad Timings for Single Data Source
listAdTimingsSingleDataSource 2 params → 200404
POST
/videos/{id}/data_sources/{data_source_id}/ad_timings
Create Ad Timing
createAdTiming 2 params body → 201422
GET
/videos/{id}/data_sources/{data_source_id}/ad_timings/{ad_timing_id}
View Ad Timing
getAdTiming 3 params → 200404
PUT
/videos/{id}/data_sources/{data_source_id}/ad_timings/{ad_timing_id}
Update Ad Timing
updateAdTiming 3 params body → 204404
DELETE
/videos/{id}/data_sources/{data_source_id}/ad_timings/{ad_timing_id}
Destroy Ad Timing
destroyAdTiming 3 params → 200404
GET
/videos/{id}/video_sources
List Video Sources for a Video
listVideoSourcesForVideo 1 param → 200
POST
/videos/self_hosted
Create Self Hosted Video
createSelfHostedVideo body → 201422
GET
/videos/{video_id}/self_hosted
List Self Hosted Video Data Sources
listSelfHostedVideoDataSources 1 param → 200422
POST
/videos/{video_id}/self_hosted
Create a Self Hosted Video Data Source
createSelfHostedVideoDataSource 1 param body → 201422
GET
/videos/{video_id}/self_hosted/{data_source_id}
View Self Hosted Video Data Source
getSelfHostedVideoDataSource 2 params → 200404
PUT
/videos/{video_id}/self_hosted/{data_source_id}
Update Self Hosted Video Data Source
updateSelfHostedVideoDataSource 2 params body → 200404422
DELETE
/videos/{video_id}/self_hosted/{data_source_id}
Delete Self Hosted Video Data Source
deleteSelfHostedVideoDataSource 2 params → 204404
Playlists 10
GET
/playlists
List Playlists
listPlaylists 21 params → 200422
POST
/playlists
Create Playlist
createPlaylist body → 201422
GET
/playlists/{id}
View Playlist
getPlaylist 2 params → 200404
PUT
/playlists/{id}
Update Playlist
updatePlaylist 1 param body → 200404422
DELETE
/playlists/{id}
Delete Playlist
deletePlaylist 1 param → 204404
GET
/playlists/{id}/videos
List Playlist Videos
listPlaylistVideos 8 params → 200404422
GET
/playlists/{id}/videos/relative
List Relative Playlist Videos
listPlaylistVideosRelative 10 params → 200404422
PUT
/playlists/{id}/add_videos
Add Videos
addVideosToPlaylist 1 param body → 200404422
PUT
/playlists/{id}/remove_videos
Remove Videos
removeVideosFromPlaylist 1 param body → 200404422
GET
/playlists/relationships
View Relationships
viewPlaylistRelationships 1 param → 200
Categories 5
GET
/categories
List Categories
listCategories 9 params → 200422
POST
/categories
Create Category
createCategory body → 201422
GET
/categories/{id}
View Category
getCategory 1 param → 200404
PUT
/categories/{id}
Update category
updateCategory 1 param body → 200404422
DELETE
/categories/{id}
Delete Category
deleteCategory 1 param → 204404
Apps 1
GET
/app
View App
getApp 1 param → 200404
Subtitles 4
GET
/videos/{video_id}/subtitles
List Subtitles
listSubtitles 1 param → 200422
POST
/videos/{video_id}/subtitles
Create Subtitle
createSubtitle 1 param body → 201422
GET
/videos/{video_id}/subtitles/{id}
View Subtitle
getSubtitle 2 params → 200404
PUT
/videos/{video_id}/subtitles/{id}
Update Subtitle
updateSubtitle 2 params body → 200404422
Subtitle Playlists 2
POST
/videos/{video_id}/subtitle_playlists
Create Subtitle Playlist
createSubtitlePlaylist 1 param body → 201422
DELETE
/videos/{video_id}/subtitle_playlists/{language}
Delete Subtitle Playlist
deleteSubtitlePlaylist 2 params → 204
Program Guides 6
GET
/program_guides
List Program Guides
listProgramGuides 7 params → 200422
POST
/program_guides
Create Program Guide
createProgramGuide body → 201422
GET
/program_guides/{id}
View Program Guide
getProgramGuide 1 param → 200404
PUT
/program_guides/{id}
Update Program Guide
updateProgramGuide 1 param body → 200404422
DELETE
/program_guides/{id}
Delete Program Guide
deleteProgramGuide 1 param → 204404
GET
/program_guides/{id}/entries
List Program Guide Entries
listProgramGuideEntries 11 params → 200404
Devices 2
GET
/devices
List Devices
listDevices 8 params → 200422
GET
/devices/{id}
View Device
getDevice 1 param → 200404
Device Categories 2
GET
/device_categories
List Devices Categories
listDeviceCategories 8 params → 200422
GET
/device_categories/{id}
View Device Category
getDeviceCategory 1 param → 200404
GeoIP 1
GET
/geoip
View GeoIP
getGeoIP 1 param → 200
Segments 5
GET
/videos/{video_id}/segments
List Segments
listSegments 1 param → 200
POST
/videos/{video_id}/segments
Create Segment
createSegment 1 param body → 201422
GET
/videos/{video_id}/segments/{id}
View Segment
getSegment 2 params → 200
PUT
/videos/{video_id}/segments/{id}
Update Segment
updateSegment 2 params body → 200
DELETE
/videos/{video_id}/segments/{id}
Delete Segment
deleteSegment 2 params → 204404
Transcriptions 5
GET
/videos/{id}/transcriptions
List Transcriptions
listTranscriptions 1 param → 200404
GET
/videos/{id}/transcriptions/{transcription_id}
View Transcription
getTranslation 2 params → 200404
POST
/videos/{id}/transcriptions/transcribe
Transcribe video
transcribeVideo 1 param → 200404422
POST
/videos/{id}/transcriptions/translate
Translate video
translateVideo 1 param body → 200404422
GET
/videos/{id}/transcriptions/translation_languages
List translation languages
listLanguages 1 param → 200404
Video Imports 4
GET
/video_imports
List Video Imports
listVideoImports 12 params → 200
POST
/video_imports
Create Video Import
createVideoImport body → 200422
PUT
/video_imports/{id}/add_video
Attach a Video to a Video Import
addVideoToImport 1 param body → 201404422
GET
/video_imports/{id}
View Video Import
getVideoImport 1 param → 200404
Video Sources 5
GET
/video_sources
List Video Sources
listVideoSources 9 params → 200
POST
/video_sources
Create Video Source
createVideoSource body → 201422
GET
/video_sources/{id}
View Video Source
getVideoSource 1 param → 200404
PUT
/video_sources/{id}
Update Video Source
updateVideoSource 1 param body → 200404422
DELETE
/video_sources/{id}
Delete a Video Source
deleteVideoSource 1 param → 204404
Users 5
GET
/site/users
List Admin Users
listUsers 8 params → 200422
POST
/site/users
Create User
createUser body → 200422
GET
/site/users/{id}
View User
getUser 1 param → 200404
PUT
/site/users/{id}
Update user
updateUser 1 param body → 200404422
PUT
/site/users/{id}/remove
Remove an admin user from your property.
removeUser 1 param → 201404422
Encoders 6
GET
/live/encoders
List Encoders
listV1Encoders → 200422
GET
/live/encoders/{encoder_name}
View Encoder
getV1Encoder 1 param → 200404
POST
/live/encoders/{encoder_name}/start
Start an Encoder
startV1Encoder 2 params → 200400404
POST
/live/encoders/{encoder_name}/stop
Stop an Encoder
stopV1Encoder 1 param → 200400404
GET
/live/encoders/{encoder_name}/target_rtmp
List Targets RTMP entries
listTargetRtmp 1 param → 200
GET
/live/encoders/{encoder_name}/target_rtmp/{target_rtmp_name}
View Target RTMP entry
getTargetRTMP 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zype-platform.json Raw ↑

Other APIs Zype publishes across the network.

Zype Playout Scheduler API
Zype Monetization API
Zype Consumers API
Zype Live API (V3)
Zype Zobjects API
Zype Analytics API (V3)
Zype Analytics API (V2)
Zype Custom Regions API
Zype Content Rule Groups API
Zype Content Rule Profiles API
Zype TVE API
Zype Consumer Authentication API
Where this information came from

This is an independent, third-party profile of Zype Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.