Asset Operations API endpoints
Get a list of Discovered Assets
GET /v3/asset?page=x&size=y&tags=z&text=w - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose:
Enables to generate a full list of virtualized assets in your LVS Tenant, including both active and inactive assets. You may filter this list by asset name, asset id, asset tags, and limited date rules (date asset created for preset time frames).
Response consists of an Array of AssetInfo objects (content parameter) containing description of every discovered Asset and the following standard Spring Boot PageImpl parameters.
Example
GET https://api.lvs.linius.com/v3/asset?text=demo
Response body:
{
"content": [
{
"id": "980192",
"name": "Demo One",
"duration": 543.417,
"tags": [
"test"
],
"thumbnailUrl": "https://api.lvs.linius.com/v3/assembly/thumbnail/980192.jpg",
"activated": true,
"startDate": "2022-03-24T04:00:00Z",
"representations": [
{
"id": "16917857",
"format": "MP4",
"sourceUrl": "https://s3-eu-west-2.amazonaws.com/samples.cdn.linius.com/demoone.mp4",
"sourceIdentifier": "HTTP",
"meta": {
"width": 1920,
"height": 1080
},
"duration": 543417,
"created": "2022-03-23T18:37:01.745+0000",
"secure": false
}
],
"created": "2022-03-23T18:37:01.499+0000"
},
{
"id": "928379",
"name": "Demo Two",
"duration": 247,
"tags": [
"enrich",
"face",
"test"
],
"thumbnailUrl": "https://api.lvs.linius.com/v3/assembly/thumbnail/928379.jpg",
"activated": true,
"representations": [
{
"id": "15642677",
"format": "MP4",
"sourceUrl": "https://s3-eu-west-2.amazonaws.com/samples.cdn.linius.com/demotwo.mp4",
"sourceIdentifier": "HTTP",
"meta": {
"width": 640,
"height": 360
},
"duration": 247896,
"created": "2022-01-21T18:37:40.492+0000",
"secure": false
}
],
"created": "2022-01-21T18:36:23.286+0000"
}
],
"first": true,
"last": true,
"number": 0,
"numberOfElements": 2,
"size": 50,
"sort": null,
"totalElements": 2,
"totalPages": 1
}
Get a single Discovered Asset
GET /v3/asset/{assetId} - Click here to view and test API specs (LVS login required)
Purpose
Allows you to view all available asset-level metadata for a specific asset ID.
Example
GET https://api.lvs.linius.com/v3/asset/1016425
Response Body:
{
"id": "1016425",
"name": "Destination Earth",
"duration": 819.688,
"tags": [
"public domain",
"test"
],
"thumbnailUrl": "https://api.lvs.linius.com/v2/assembly/thumbnail/1016425.jpg",
"activated": true,
"representations": [
{
"id": "17918208",
"format": "MP4",
"sourceUrl": "https://s3-eu-west-2.amazonaws.com/samples.cdn.linius.com/LVS-samples/Destination_Earth.mp4",
"sourceIdentifier": "HTTP",
"meta": {
"width": 640,
"height": 478
},
"duration": 819688,
"created": "2022-05-11T01:27:17.332+0000",
"secure": false
}
],
"created": "2022-05-11T01:27:17.066+0000"
}
________________
Get amount of active Assets
GET /v3/asset/count - Click here for this endpoint's full API specs and testing tool (LVS login required)
Use this endpoint to retrieve a count of all ACTIVE assets for a specified tenant.
________________
Update an existing Asset’s metadata
PUT /v3/asset/{assetId} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose:
Use this endpoint to change an already-discovered Asset record's metadata, including:
- Active/Inactive Status (i.e. whether asset should be available for Search and/or Assembly.
- Asset Name (i.e. title)
- Asset tags
- Asset thumbnail
Example
PUT https://api.lvs.linius.com/v3/asset/1016425
Request Body:
{
"activated": true,
"name": "Demo Three",
"tags": [
"tag1",
"tag2",
"tag3"
],
"thumbnailUrl": "\"https://upload.wikimedia.org/wikipedia/commons/thumb/c/c5/Big_buck_bunny_poster_big.jpg/800px-Big_buck_bunny_poster_big.jpg"
}
Response body:
{
"id": "1016425",
"name": "Demo Three",
"duration": 819.688,
"tags": [
"tag1",
"tag2",
"tag3"
],
"thumbnailUrl": "\"https://upload.wikimedia.org/wikipedia/commons/thumb/c/c5/Big_buck_bunny_poster_big.jpg/800px-Big_buck_bunny_poster_big.jpg",
"activated": true,
"representations": [
{
"id": "17918208",
"format": "MP4",
"sourceUrl": "https://s3-eu-west-2.amazonaws.com/samples.cdn.linius.com/LVS-samples/Destination_Earth.mp4",
"sourceIdentifier": "HTTP",
"meta": {
"width": 640,
"height": 478
},
"duration": 819688,
"created": "2022-05-11T01:27:17.332+0000",
"secure": false
}
],
"created": "2022-05-11T01:27:17.066+0000"
}
Get Last Update of Assets by assetId
GET /v3/asset/updated - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Use this endpoint to retrieve the date/time that each specified was changed, and the username of the user that made the change.
________________
Update a specific asset's visibility by date (change asset Start and End dates)
PUT /v3/asset/{assetId}/dates - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
This endpoint enables you to change a specified asset's Start and End dates, for the purposes of filtering Search results by date, or any situation where you need to display asset-level date metadata.
________________
Delete Asset
DELETE /assembly/asset/{assetId} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
This endpoint enables you to delete an Asset by specifying assetId.Use this endpoint in cases where you want to PERMANENTLY an asset record and all of its associated metadata (included clip-level metadata used for Search),e.g.:
- when the usage/distribution rights have expired
- when you need to remove a meeting recording for the purpose of confidentiality.
Please note: Use the "Update Asset Visibility" endpoint instead of the "Delete Asset" endpoint if you only want to temporarily prevent an asset from being used in Search or Assembly. |
Example
DELETE https://api.lvs.linius.com/v3/asset/54906
Get Keyframes for Asset
GET /v3/asset/{assetId}/keyframes - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Allows you to get all available Keyframes for an existing MP4 asset. Specify assetId for the Asset.
Use this endpoint in applications where you need to display the precise timecodes where an MP4 asset can be split or joined in an assembly (e.g. an editing tool).
Example
GET https://api.lvs.linius.com/v3/asset/486330/keyframes
Response body:
{
"0": 0,
"300": 10,
"600": 20,
"900": 30
}
________________
Get Timecode Offsets of segment/chunked breakpoints
GET /v3/asset/segment-offset - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Allows you to get information about how a specific HLS asset has been segmented/chunked.
Use this endpoint in applications where you need to display the precise timecodes where an HLS asset can be split or joined in an assembly (e.g. an editing tool).
Example
GET https://api.lvs.linius.com/v3/asset/segment-offset?id=792316
Response body:
{
"format": "HLS_MEDIA",
"items": [
{
"assetId": "792316",
"offsets": [
0,
5339,
10677,
16016,
21355
]
}
]
}
________________
Get a single Asset's Representations
GET /v3/asset/{assetId}/representation/ - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
This endpoint enables you to view information about a specific Asset's HLS and MP4 sources, including URLs, duration, dimensions, and date updated.
Example
GET https://api.lvs.linius.com/v3/asset/944861/representation/
Response body:
[
{
"id": "16072556",
"format": "HLS_MASTER",
"sourceUrl": "https://s3-eu-west-2.amazonaws.com/samples.cdn.linius.com/medical/lecture1/playlist.m3u8",
"sourceIdentifier": "HTTP",
"meta": {},
"duration": 300000,
"created": "2022-02-11T15:16:11.610+0000",
"secure": false
},
{
"id": "16072522",
"format": "MP4",
"sourceUrl": "https://s3-eu-west-2.amazonaws.com/samples.cdn.linius.com/medical/lecture1.mp4",
"sourceIdentifier": "HTTP",
"meta": {
"width": 1920,
"height": 1080
},
"duration": 304461,
"created": "2022-02-11T15:15:11.485+0000",
"secure": false
}
]
________________
Update a specific Representation's description
PUT /v3/asset/{assetId}/representation/{representationId} - Click here for this endpoint's full API specs and testing tool (LVS login required)
Purpose
Use this endpoint to update an asset representation with an optional description.
Use cases for asset representation descriptions might include storing technical details about the source video (e.g. "broadcast game footage" it easier to identify videos within an LVS-enabled content management workflow.
Example
Response body
{
"id": "16072522",
"format": "MP4",
"description": "broadcast game footage",
"sourceUrl": "https://s3-eu-west-2.amazonaws.com/samples.cdn.linius.com/orioles.mp4",
"sourceIdentifier": "HTTP",
"meta": {
"width": 1920,
"height": 1080
},
"duration": 304461,
"created": "2022-02-11T15:15:11.485+0000",
"secure": false
}
________________
Delete a specific Representation's description
DELETE /v3/asset/{assetId}/representation/{representationId}
Purpose
Use this endpoint to remove an MP4 or HLS source URL (typically before using "Discover Asset Representation" endpoint to add an updated MP4 or HLS source URL.
Example
DELETE https://api.lvs.linius.com/v3/asset/944861/representation/16072556
Comments
0 comments
Article is closed for comments.