This section provides detailed information on all available result APIs including links to OpenAPI specifications and online documentation.
All of these result APIs require an API key for access. Partners can receive their API key from their Vionlabs integration lead. It should be noted although partners receive a single API key to authenticate calls with all Vionlabs Discovery Platform APIs, access authorization is configured separately on each API. Partner authorization for APIs is configured based on the agreed commercial contract.
Authentication
Authentication for all Result APIs is handled by passing a key parameter with your API key in each request. This key is used to identify your organization and verify your access to the requested API resources.
Getting an API Key
To get an API key, please contact our customer support team. Each customer is provided with a unique API key that grants access to the specific APIs included in their service agreement.
Most of the APIs are providing results relating to items specified in a partner's catalog. The item identifiers used in both requests and responses are always the partner's identifiers for the items as specified in the catalog. Internal Vionlabs identifiers are never used on the APIs.
A number of the APIs are designated as "windowed". This means that, in addition to deleted items, items that are outside their available window are excluded from results. Item window information can be configured for items in using the standard catalog model.
Some API methods provide results for series items. In many cases, the API can be configured by Vionlabs to provide either the item identifier for the series (which is the default) or the identifier for the earliest episode of the series available in catalog. This is configured independently for each partner integration. Please advise your Vionlabs integration lead should you with to change this from the default. First episodes are automatically calculated by the platform, including the use of available window information if it is provided.
This section provides detailed information about all available Result APIs, including links to their OpenAPI specifications and online documentation.
All Result APIs require an API key for access. Partners receive a single API key from their Vionlabs integration lead; however, access authorization is configured individually for each API, based on the commercial agreement.
Catalog Integration and Identifiers
All Result APIs operate on partner-defined item identifiers, consistent with the identifiers used in the partner’s catalog integration.
Vionlabs internal IDs are never exposed via the public APIs.
Series Items
For APIs returning results on series-type items, Vionlabs can configure your integration to:
Use the series identifier (default), or
Use the earliest available episode identifier.
Configuration is handled per partner. Contact your integration lead if you wish to change this default.
Result API Reference
API Name |
Description |
|---|---|
Content Similarity API |
Returns a list of similar items based on content-level similarity analysis. Useful for “more like this” recommendations. |
Binge Markers API |
Provides start and end timestamps for skippable segments (intro, recap, end credits) to enhance binge-watching experiences. |
Fingerprint+ API |
Returns raw fingerprint data along with metadata such as mood and genre categories for each asset. |
Ad Breaks API |
Suggests non-disruptive time slots for ad insertion based on story flow. Results include ranked confidence levels (1–4). |
Contextual Ad Breaks API |
Enhances ad placement with contextual metadata — moods, IAB categories, and keywords for each ad slot. |
Thumbnails API |
Suggests high-quality frames for use as thumbnails, with control over brightness, facial attributes, and diversity spacing. |
Previews API |
Provides video timestamps for short preview clips, supporting emotion-based or character-targeted segments. |
Emotions API |
Delivers extracted emotions per 5-second video segment (anger, enjoyment, surprise, disgust, fear, sadness) with VAD values. |
Video-Text Retrieval API |
Enables semantic search for titles using natural language queries such as “funny romantic movies” or “thrilling car chase.” |
Scene Retrieval API |
Returns embeddings for video scenes that can be indexed in vector databases for fine-grained scene search. |
Profanity Detection API |
Detects and classifies profane language segments with confidence scores and content-level severity categorization. |
Nudity Detection API |
Detects and classifies nudity occurrences, providing timestamped scores and overall content categorization. |
Content Summary API |
Generates chapter-level and global summaries with extracted keywords, improving content navigation and discovery. |