For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
ModelsAgents (Research preview)SDK ReferenceAPI Reference
ModelsAgents (Research preview)SDK ReferenceAPI Reference
  • TwelveLabs API
    • Introduction
    • Authentication
  • Assets and entities
    • Overview
    • Upload content
    • Manage entities
  • Agents (Research preview)
    • Overview
    • Knowledge stores
    • Search a knowledge store
    • Knowledge store items
    • Responses
  • Models and search
    • Overview
    • Manage indexes
    • Index content
    • Manage videos
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
  • Introduction
  • Authentication
  • Overview
  • Upload content
  • Direct uploads
  • Create an asset
  • Retrieve an asset
  • List assets
  • Delete an asset
  • Update the user-defined metadata of an asset
  • Replace the user-defined metadata of an asset
  • Delete the user-defined metadata of an asset
  • Multipart uploads
  • Create a multipart upload session
  • Retrieve the status of an upload session
  • List incomplete uploads
  • Report uploaded chunks
  • Request presigned URLs for the remaining chunks
  • Video indexing tasks
  • The task object
  • Create a video indexing task
  • List video indexing tasks
  • Retrieve a video indexing task
  • Delete a video indexing task
  • Manage entities
  • List entity collections
  • Create an entity collection
  • Retrieve an entity collection
  • Update an entity collection
  • Delete an entity collection
  • List entities in an entity collection
  • Create an entity
  • Create multiple entities in bulk
  • Retrieve an entity
  • Update an entity
  • Delete an entity
  • Add assets to an entity
  • Remove assets from an entity
  • List entities for an asset
  • Overview
  • Knowledge stores
  • The knowledge store object
  • Create a knowledge store
  • List knowledge stores
  • Retrieve a knowledge store
  • Update a knowledge store
  • Delete a knowledge store
  • Search a knowledge store
  • Search a knowledge store
  • Knowledge store items
  • The knowledge store item object
  • Create a knowledge store item
  • List knowledge store items
  • Retrieve a knowledge store item
  • Delete a knowledge store item
  • Create an item collection
  • List item collections
  • Retrieve an item collection
  • Update an item collection
  • Delete an item collection
  • List items in an item collection
  • Add items to an item collection
  • Remove items from an item collection
  • Responses
  • The response object
  • Create a response
  • Create a response (streaming)
  • Overview
  • Manage indexes
  • The index object
  • Create an index
  • List indexes
  • Retrieve an index
  • Update an index
  • Delete an index
  • Index content
  • Index an asset
  • Retrieve an indexed asset
  • List indexed assets
  • Delete an indexed asset
  • Partial update indexed asset
  • List indexed assets for an asset
  • Manage videos
  • The video object
  • List videos
  • Retrieve video information
  • Partial update video information
  • Delete video information
  • Any-to-video search
  • Make any-to-video search requests
  • Retrieve a specific page of search results
  • Create embeddings v2
  • Create sync embeddings
  • Create an async embedding task
  • List async embedding tasks
  • Retrieve task status and results
  • Create embeddings v1
  • Create video embeddings
  • The video embedding object
  • Create a video embedding task
  • List video embedding tasks
  • Retrieve the status of a video embedding task
  • Retrieve video embeddings
  • Create text, image, and audio embeddings
  • The embedding object
  • Create embeddings for text, image, and audio
  • Analyze and segment videos
  • Sync analysis
  • Create an async analysis task
  • List async analysis tasks
  • Retrieve analysis task status and results
  • Delete an analysis task
  • Batch analysis
  • The batch object
  • Create a batch
  • List batches
  • Retrieve batch status
  • Retrieve batch results
  • Cancel a batch
  • Delete a batch
  • Error codes
Sample appsIntegrationsDiscordPlaygroundDevEx repo
Agents (Research preview)

Agents (Research preview)

Knowledge stores

A knowledge store contains your videos and the understanding the platform derives from them. Agents use knowledge stores to reason across the full collection.

Knowledge store items

Add and manage items within a knowledge store.

Knowledge store item collections

Organize items into named collections that can be referenced together.

Search a knowledge store

Search a knowledge store with natural language and retrieve matching clips ranked by relevance.

Responses

Generate responses from a knowledge store.

Was this page helpful?
Previous

Knowledge stores

Next
Built with