Skip to main content
PUT
/
indexes
/
{index_id}
Update Index
curl --request PUT \
  --url http://0.0.0.0:8008/indexes/{index_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "default_features": [
    "proxy"
  ],
  "num_assets": 123,
  "size_bytes": 123,
  "total_tokens_used": 123,
  "duration": 123,
  "sample_prompts": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "num_assets": 123,
  "size_bytes": 123,
  "total_tokens_used": 123,
  "duration": 123,
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_features": [
    "proxy"
  ],
  "is_sample": true,
  "is_sample_ready": true,
  "sample_prompts": [
    "<string>"
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT in Authorization header. 'Bearer ' prefix optional.

Path Parameters

​
index_id
string<uuid>
required

The ID of the index to update

Body

application/json

API request schema for updating an index

​
name
string | null
​
description
string | null
​
default_features
enum<string>[] | null

Feature types that are exposed to users via the API

Available options:
proxy,
preview,
visual,
transcription
​
num_assets
integer | null
​
size_bytes
integer | null
​
total_tokens_used
integer | null
​
duration
number | null
​
sample_prompts
string[] | null

Response

Successful Response

API response schema for updating an index

​
id
string<uuid>
required
​
name
string
required
​
description
string | null
required
​
num_assets
integer
required
​
size_bytes
integer
required
​
total_tokens_used
integer
required
​
duration
number
required
​
user_id
string<uuid> | null
required
​
default_features
enum<string>[]
required

Feature types that are exposed to users via the API

Available options:
proxy,
preview,
visual,
transcription
​
is_sample
boolean
required
​
is_sample_ready
boolean
required
​
sample_prompts
string[]
required
​
created
string<date-time>
required
​
updated
string<date-time>
required