Skip to main content
POST
Create a Collection

Authorizations

x-api-key
string
header
required

Project API Key.

Body

application/json
collectionName
string
required

Collection name unique within the project.

Pattern: ^[a-zA-Z0-9_-]{3,52}$
indexConfigs
IndexConfigs · object
required

Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected.

description
string
Maximum string length: 255
tags
object

Collection metadata tags. Up to five entries.

partitionConfig
PartitionConfig · object
snapshotRetentionInDays
integer
default:30

Number of days to retain committed snapshots.

Required range: 1 <= x <= 31

Response

Collection created.

collection
object
required