For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • TwelveLabs API
    • Introduction
    • Authentication
  • API Reference
    • Manage indexes
    • Upload content
      • Direct uploads
        • POSTCreate an asset
        • GETRetrieve an asset
        • GETList assets
        • DELDelete an asset
        • PATCHUpdate the user-defined metadata of an asset
        • DELDelete the user-defined metadata of an asset
      • Multipart uploads
      • Video indexing tasks
    • Index content
    • Manage videos
    • Manage entities
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceUpload contentDirect uploads

List assets

GET
https://api.twelvelabs.io/v1.3/assets
GET
/v1.3/assets
$curl -G https://api.twelvelabs.io/v1.3/assets \
>     -H "x-api-key: <apiKey>" \
>     -d asset_ids=6298d673f1090f1100476d4c \
>     -d asset_ids=6298d673f1090f1100476d4d \
>     -d asset_types=image \
>     -d asset_types=video \
>     -d filename=meeting
1{
2  "data": [
3    {
4      "_id": "6298d673f1090f1100476d4c",
5      "created_at": "2022-06-02T10:30:00Z",
6      "duration": 120.5,
7      "file_type": "image/jpeg",
8      "filename": "image-01.jpg",
9      "hls": {
10        "manifest_url": "https://cdn.example.com/assets/6298d673f1090f1100476d4c/manifest.m3u8",
11        "status": "ready"
12      },
13      "method": "direct",
14      "size": 104857600,
15      "status": "ready",
16      "thumbnail": {
17        "representative_url": "https://cdn.example.com/assets/6298d673f1090f1100476d4c/thumbnail.jpg",
18        "status": "ready"
19      },
20      "user_metadata": {}
21    }
22  ],
23  "page_info": {
24    "limit_per_page": 10,
25    "page": 1,
26    "total_page": 1,
27    "total_results": 2
28  }
29}
This method returns a list of assets in your account. The platform returns your assets sorted by creation date, with the newest at the top of the list.
Was this page helpful?
Previous

Delete an asset

Next
Built with

Authentication

x-api-keystring

Your API key.

Note

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

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:
filenamestringOptional

Filters the response to include only assets whose filename contains the specified string. The match is case-insensitive and supports partial matching.

Response

The assets have been successfully retrieved.
datalist of objects
An array containing the assets.
page_infoobject
An object that provides information about pagination.

Errors

400
Bad Request Error