CAcasemark
Vaults

Create a new vault

Changed on

Creates a new secure vault with dedicated S3 storage and vector search capabilities. Each vault provides isolated document storage with semantic search and OCR processing for legal document analysis and discovery.

post/vault

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/vault
  • Auth
    HTTP bearer

Request body

namestring required

Display name for the vault

descriptionstring

Optional description of the vault's purpose

enableIndexingboolean

Enable vector indexing and search capabilities. Set to false for storage-only vaults.

metadataobject

Optional metadata to attach to the vault (e.g., { containsPHI: true } for HIPAA compliance tracking)

groupIdstring

Assign the vault to a vault group for access control. Required when using a group-scoped API key.

embeddingModel'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | 'voyage/voyage-3.5' | 'voyage/voyage-law-2' | 'cohere/embed-v4.0' | 'google/gemini-embedding-2' | 'casemark/embed-v1' | 'casemark/llama-nemotron-embed-vl-1b-v2'

Optional embedding model for this vault. Defaults to casemark/embed-v1. Determines the S3 Vectors index dimension and which model is used at both ingest and search time. The vault is locked to this model after creation — use a re-embed flow to change later. Ignored when enableIndexing is false. Note: casemark/llama-nemotron-embed-vl-1b-v2 is a deprecated alias for casemark/embed-v1 (retained for SDK backward compatibility); new integrations should use casemark/embed-v1 directly.

Example request

{
  "name": "Contract Review Archive",
  "description": "Repository for all client contract reviews and analysis",
  "enableIndexing": true,
  "metadata": {
    "containsPHI": true,
    "hipaaCompliant": true
  },
  "groupId": "grp_abc123",
  "embeddingModel": "casemark/embed-v1"
}

Response

Vault created successfully

idstring

Unique vault identifier

namestring

Vault display name

descriptionstring

Vault description

filesBucketstring

S3 bucket name for document storage

vectorBucketstring nullable

S3 bucket name for vector embeddings. Null for storage-only vaults.

indexNamestring nullable

Vector search index name. Null for storage-only vaults.

enableIndexingboolean

Whether vector indexing is enabled for this vault

regionstring

AWS region for storage

createdAtstring date-time

Vault creation timestamp

Changes