Create a new vault

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

POST /vault

cURL

cURL

curl -X POST "https://api.case.dev/vault" \ -H "Authorization: Bearer $CASEDEV_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Contract Review Archive" }'

201

{
  "id": "vault_2NqPkJ8xK9LmN3pQ",
  "name": "Contract Review Archive",
  "description": "Repository for all client contract reviews and analysis",
  "filesBucket": "case-vault-acme-legal-vault_2NqPkJ8xK9LmN3pQ",
  "vectorBucket": "case-vault-acme-legal-vault_2NqPkJ8xK9LmN3pQ-vectors",
  "indexName": "embeddings",
  "enableIndexing": true,
  "region": "us-east-1",
  "createdAt": "2024-01-15T10:30:00Z"
}

Authorizations

Authorization · string · header · required

API key starting with sk_case_

Body

application/json

name · string · required

Display name for the vault

Example:

"Contract Review Archive"

description · string

Optional description of the vault's purpose

Example:

"Repository for all client contract reviews and analysis"

enableGraph · boolean · default: true

Enable knowledge graph for entity relationship mapping. Only applies when enableIndexing is true.

Example:

true

enableIndexing · boolean · default: true

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

Example:

true

metadata · object

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

Example:

{
  "containsPHI": true,
  "hipaaCompliant": true
}

groupId · string

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

Example:

"grp_abc123"

embeddingModel · enum<string> · default: casemark/embed-v1

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.

Available options: 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

Example:

"casemark/embed-v1"

Response

201

application/json

Vault created successfully

id · string

Unique vault identifier

name · string

Vault display name

description · string

Vault description

filesBucket · string

S3 bucket name for document storage

vectorBucket · string | null

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

indexName · string | null

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

enableIndexing · boolean

Whether vector indexing is enabled for this vault

region · string

AWS region for storage

embeddingProfile · object

The resolved embedding profile for this vault. Null for storage-only vaults.

Show child attributes

createdAt · string<date-time>

Vault creation timestamp