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
    • Index content
      • POSTIndex an asset
      • GETRetrieve an indexed asset
      • GETList indexed assets
      • DELDelete an indexed asset
      • PATCHPartial update indexed asset
      • GETList indexed assets for an asset
    • Manage videos
    • Manage entities
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
On this page
  • Workflow
API Reference

Index content

Was this page helpful?
Previous

Index an asset

Next
Built with

Index your uploaded assets to make them searchable and analyzable.

Workflow

Before you begin, create an index if you don’t have one.

1

Upload your content using direct uploads or multipart uploads. The platform creates an asset and returns its unique identifier.

2

For URL uploads larger than 200 MB, check the asset status using the GET method of the /assets/{asset-id} endpoint until the status field is ready before proceeding.

3

Index your content using the POST method of the /indexes/{index-id}/indexed-assets.

4

Monitor the indexing status until it shows ready using the GET method of the /indexes/{index-id}/indexed-assets/{indexed-asset-id} endpoint.

5

Search or analyze your content.