Skip to main content
All API actions are multiplexed through the /manage endpoint. Provide an action string plus the required fields for that operation. On success, handlers return 2xx JSON payloads outlined below. Failures return structured errors: 
{
  "error": "Human-readable message",
  "action": "createIndex" // present on server errors
}
Shared request schema:
FieldTypeRequiredNotes
actionstring✅One of createIndex, getIndex, listIndexes, deleteIndex, addDocs, deleteDocs, getDocs.
projectIdstring✅Project identifier issued by Moss Control.
indexNamestring▶︎Required for index-scoped actions.
Required headers: x-project-key with your project access key and x-service-version: v1.

​
Supported actions at a glance

ActionPurposeExtra required fields
createIndexCreate a new index with seed documents.indexName, docs
getIndexFetch metadata for a single index.indexName
listIndexesEnumerate every index under the project.—
deleteIndexRemove an index record and assets.indexName
addDocsUpsert documents into an existing index.indexName, docs
deleteDocsRemove documents by ID.indexName, docIds
getDocsRetrieve stored documents (without embeddings).indexName