API Reference

List indexes

get
https://api.twelvelabs.io/v1.3/indexes

This method returns a list of the indexes in your account. The API returns indexes sorted by creation date, with the oldest indexes at the top of the list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 1

A number that identifies the page to retrieve.

Default: 1.

integer
Defaults to 10

The number of items to return on each page.

Default: 10.
Max: 50.

string
Defaults to created_at

The field to sort on. The following options are available:

  • updated_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was updated.
  • created_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was created.

Default: created_at.

string
Defaults to desc

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

string

Filter by the name of an index.

string

Filter by the model options. When filtering by multiple model options, the values must be comma-separated.

string

Filter by the model family. This parameter can take one of the following values: marengo or pegasus. You can specify a single value.

string

Filter indexes by the creation date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns the indexes that were created on the specified date at or after the given time.

string

Filter indexes by the last update date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns the indexes that were last updated on the specified date at or after the given time.

Headers
string
required

Your API key.

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

Responses

Updated about 1 year ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?