Skip to main content
POST

Authorizations

Authorization
string
header
required

Tenant-scoped API key beginning with qkv_live_.

Body

application/json
name
string
required

Human-readable name unique within the authenticated tenant.

Minimum string length: 1
model
string

Optional supported model name. Omit unless instructed during onboarding.

Minimum string length: 1
text_retention
enum<string>
default:none
Available options:
none
chunking
object
metadata_schema
object

Descriptive customer metadata schema recorded with the index.

Response

Index created

id
string<uuid>
required
name
string
required
Minimum string length: 1
model
string
required
Minimum string length: 1
model_version
string
required

Immutable serving version for this index.

Minimum string length: 1
text_retention
enum<string>
required
Available options:
none
chunking
object
required
metadata_schema
object
required
status
enum<string>
required
Available options:
creating,
ready,
error
created_at
string<date-time>
required