Overview
The main function of the Search Data Management API Endpoints listed on this page is to create and manage searchable Video Clip metadata. These endpoints are typically used by applications that ingest video metadata from such 3rd party data sources as AI services, transcription services, learning management systems, specialized sports data providers, or any bespoke data source (e.g. comments and other inputs from end-users).
These endpoints follow the standard JSON Video Clip data template documented here.
For more information about Enrichment and the data ingestion process, please consult the the "Enriching your Video Content with Video Clip Data" article.
V3 Search Data Management API Endpoints
Please note: These endpoints do not allow you to directly modify the Compound Clips used by LVS Advanced Search. Compound Clips are automatically generated for each unique overlap of Simple Video Clips on an Asset's timeline, and are automatically updated whenever you modify or delete corresponding Video Clips.
For more information about the difference between Simple Video Clips and Compound Clips, please consult the Search API Overview article.
_____________________________
Create Simple Video Clip object
POST /v3/search - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Create a single searchable Video Clip object within an asset. This is a good option for any LVS-integrated application that needs to create incremental, ad-hoc video clips (e.g. adding searchable comments as part of a video production workflow)
_____________________________
Create Simple Video Clips in batch mode
POST /v3/search/batch - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Create up to 100 clips at once in a single request. This endpoint is intended for situations where you want to ingest a small amount of Video Clip metadata and make it searchable as quickly as possible.
_____________________________
Create Simple Video Clips in batch mode with Job (asynchronous method)
POST /v3/search/batch/jobs - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Create up to 5000 clips with a JSON file upload. Depending on the size of the batch, it may take a few minutes for this data to become searchable. This method is a good choice for ingesting data from AI services, transcription services, sports data providers, etc.
_____________________________
Get Video Clip object
[GET] /v3/search/{id} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
View metadata for a specified simple Video Clip.
_____________________________
Update Video Clip object
[PUT] /v3/search/{id} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Update metadata for a specific simple Video Clip. (E.g. adjust timecodes, correct spelling in a transcription, etc.).
_____________________________
Delete Simple Video Clip object
[DELETE] /v3/search/{id} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Delete a single Simple Video Clip object by specifying a Video Clip ID.
_____________________________
Delete Simple VideoClip objects in batch mode with Job (asynchronous method)
[POST] /v3/search/batch/deletejobs - Click here for this endpoint's full API specs and testing tool (LVS login required)
Delete multiple Simple Video Clip Objects using an uploaded JSON file. This method also enables you to delete specific Video Clip IDs or delete all Video Clips with a specific Indexer Type (i.e. data source).
_____________________________
Get Job of batch operation by job ID
[GET] /v3/search/batch/jobs/{id} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Specify a job ID to to monitor the status of a batch create or batch delete job (i.e. check whether job is still processing, see # of clips successfully created or # of clips failed) of any batch operation by ID.
_____________________________
Get statuses of batch jobs by asset id
[GET] /v3/search/batch/jobs/status - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Specify multiple asset IDs to monitor the status of batch jobs (delete or create) applied to those assets.
_____________________________
Partial update of Videos Clip object (patch method)
[PATCH] /v3/search/{id} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Update metadata for a specified simple Video Clip using the RSC 6902 JSON patch method, which enables you to search, replace, copy, and move values within a Video Clip payload. This may be a good choice if you want to replace specific values within a video clip (e.g. replace a name, change Indexer type).
_____________________________
Apply a Face Alias
[PUT] /v3/search/aliases/payloads - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
This endpoint enables you to attach an alternate name (e.g. a user-friendly display name or nickname) to face recognized by LVS's integrated AI service. This alias will be applied to all Video Clips associated with that recognized face. (Example: Apply the alias "President Bill Clinton" to all instances of "William Jefferson Clinton".)
_____________________________
Delete a Face Alias
[DELETE] /v3/search/aliases/payloads/{payloadId}
This endpoint removes an alias (e.g. user-friendly display name) from all Video Clips associated with a specific face recognized by LVS's integrated AI service.
Comments
0 comments
Article is closed for comments.