Skip to main content
POST
Create index

Authorizations

better-auth.session_token
string
cookie
required

Body

application/json
fieldMappings
object[]
required
Minimum array length: 1
indexId
string
required
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]{2,254}$
timestampField
string
required
Minimum string length: 1
commitTimeoutSecs
integer
Required range: x >= 1
defaultSearchFields
string[]
Minimum string length: 1
dynamicMapping
object
indexFieldPresence
boolean
indexUri
string
Minimum string length: 1
maxNumPartitions
integer
Required range: x >= 1
mode
enum<string>
Available options:
dynamic,
lenient,
strict
partitionKey
string
Minimum string length: 1
retention
object
storeSource
boolean
tagFields
string[]
Minimum string length: 1

Response

Successful response

displayName
string | null
required
indexId
string
required
isTraceIndex
boolean
required