Using API Explorer

The API Explorer is an interactive tool that makes it easy to:

• test-drive our personalized video capabilities with your own video content and clip data.
• learn how our clip metadata schema and APIs work by seeing them in action.
• get inspiration for your own personalized video solutions.

disclaimer: API Explorer is only compatible with V3 Search and can not be used to test V4 Search

Getting Started

Before you can use the API Explorer, you'll need to:

• Virtualize some video assets
• Create Video Clip metadata using our integrated AI Scan or by directly importing clip data.

Using API Explorer in Simple Search Mode

The Simple Search mode demonstrates how to select, sequence, and assemble video clips of a single category using the following V3 API endpoints:

• Basic V3 Search:
  • Search specific clip types - Ungrouped - GET /v3/search
  • Search specific clip types - Group by Asset - GET /v3/search/grouped).
• V3 MP4 Assembly: 
  • Assemble Number of Assets - GET /v3/assembly/vstub
  • Generate Thumbnail for an Asset and Timecode - GET /v3/thumbnail/timecode/{assetId} 
• V3 Asset Management:
  • Get a single Discovered Asset (Name, duration, etc) - GET /v3/asset/{assetId}

To find clips and generate a preview assembly:

1. Enter a search term and/or asset IDs, and choose exact or partial match. (Note: entering asset IDs restricts your search to those specific videos.
   
   

2. Select a clip category.
   
   
3. Choose grouping option: Off (Ungrouped, with results presented as individual clips) or On (Group by results by asset).
   
   
4. Choose sorting option. (Options vary according to your grouping option – please see the table at the bottom of this page.)
5. Click  (search button) to generate clip results. The API Explorer automatically assembles and presents the first set of results within the player.
   
   

{tip

Preview Lucene Query

The Lucene Query Preview panel displays the Lucene query passed to the GET /v3/search and GET /v3/search/grouped endpoints. 

Click the  icon to copy the Lucene query to the clipboard.

Inspect Clip Metadata

In the clip results panel, click on the  (eye icon) to open the relevant JSON clip metadata in a modal window.

Review Asset Metadata

In the Assets Details panel, click the  (eye icon) to open the relevant JSON Asset metadata (e.g. Asset ID, Asset Name, Asset Tags, Duration, etc.) in a modal window.

Inspect API Calls

In the API log, you can see the specific LVS API endpoints and parameters used to select, sequence, assemble, and present video clips in the API Explorer.