List assets | TwelveLabs

This method returns a list of assets in your account.

Note

The platform returns your assets sorted by creation date, with the newest at the top of the list.
The platform automatically deletes assets that are not associated with any entity after 72 hours.

This method returns a list of assets in your account. <Note title="Note"> - The platform returns your assets sorted by creation date, with the newest at the top of the list. - The platform automatically deletes assets that are not associated with any entity after 72 hours. </Note>

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Key page.

Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Query Parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

asset_idslist of stringsOptional

Filters the response to include only assets with the specified IDs. Provide one or more asset IDs. When you specify multiple IDs, the platform returns all matching assets.

asset_typeslist of enumsOptional

Filters the response to include only assets of the specified types. Provide one or more asset types. When you specify multiple types, the platform returns all matching assets.

Allowed values:

Response

The assets have been successfully retrieved.

datalist of objects or null

An array containing the assets.

page_infoobject or null

An object that provides information about pagination.

1	curl -G https://api.twelvelabs.io/v1.3/assets \
2	-H "x-api-key: <apiKey>" \
3	-d asset_ids=6298d673f1090f1100476d4c \
4	-d asset_ids=6298d673f1090f1100476d4d \
5	-d asset_types=image \
6	-d asset_types=video

1	{
2	"data": [
3	{
4	"_id": "6298d673f1090f1100476d4c",
5	"method": "direct",
6	"status": "waiting",
7	"filename": "image-01.jpg",
8	"file_type": "image/jpeg",
9	"url": "https://cdn.example.com/assets/6298d673f1090f1100476d4c",
10	"url_expires_at": "2022-06-02T10:30:00Z",
11	"created_at": "2022-06-02T10:30:00Z"
12	}
13	],
14	"page_info": {
15	"limit_per_page": 10,
16	"page": 1,
17	"total_page": 10,
18	"total_results": 10
19	}
20	}

Note

Authentication

Note

Query Parameters

Response

Errors

Note

Note