Skip to main content
POST
/
vault
Create a new vault
curl --request POST \
  --url https://api.case.dev/vault \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Contract Review Archive",
  "description": "Repository for all client contract reviews and analysis",
  "enableGraph": true,
  "enableIndexing": true,
  "metadata": {
    "containsPHI": true,
    "hipaaCompliant": true
  },
  "groupId": "grp_abc123"
}
'
{
  "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"

Response

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

​
createdAt
string<date-time>

Vault creation timestamp