Skip to main content
POST
Create Index

POST /api/v1/search/indexes

Create a new search index for organizing and searching video clips. Indexes allow you to group related videos and search across them with natural language queries.

Parameters

Response

Example Request

Example Response

Notes

  • Index names should be descriptive for easy organization
  • Use the returned index_id for uploading files and searching
  • There is no limit to the number of indexes you can create

Body

application/json
name
string
required

Name for the search index

Example:

"Sports Highlights Q4 2024"

description
string

Optional description of the index

Example:

"Collection of NFL game highlights from Q4 2024"

Response

Index created successfully

index_id
string
required

Unique identifier for the index

Example:

"idx_abc123xyz"

name
string
required

Name of the index

Example:

"Sports Highlights Q4 2024"

created_at
string<date-time>
required

ISO timestamp of when the index was created

Example:

"2024-01-15T10:30:00Z"