Collection Management
Create, configure, and curate vector collections. Ingest existing file assets, monitor index building status, and manage document lifecycles.
Create a collection
Creates a new vector collection index.
curl https://management-api.plannix.web.id/v1/collections \
-H "Authorization: Bearer ${PLANNIX_MANAGEMENT_KEY}" \
-H "Content-Type: application/json" \
-d '{
"name": "customer-support-kb",
"embedding_model": "plannix-embed-v1"
}'List all collections
Lists all collections in your organization.
Get metadata of a collection
Returns document counts, total chunk tokens, and indexing state.
Delete a collection
Permanently destroys a vector collection and all its index shards.
Update a collection's configuration
Modifies collection name, description, or default search filters.
Add existing document to a collection
Enqueues an uploaded file from the Files API into the collection's automated chunking queue.
List documents in a collection
Returns all active documents inside the collection.
Retrieve document metadata
Inspects chunk distribution, parsing status, and checksum.
Regenerate indices for given document
Forces re-chunking and re-embedding of document contents.
Remove document from a collection
Unlinks a document and purges its vector shards from the index.
Batch get document's metadata
Fetches metadata for up to 100 document IDs in a single call.