Create vault

The MCP server is in public beta. It is open to use and still being refined, so tools and behavior may change.

Tool create_vault · Behavior Additive

Create a Contract Intelligence vault. The caller becomes its owner and the vault starts private to them, so nobody else sees it until they are added in the app. The vault is ready for documents right away: add them with upload_file using the returned id as vault_id, then add the columns you want extracted with create_vault_column. Creating a vault needs a permission an organization admin grants.

Input parameters

string

Vault name. Omit and GC AI picks the next free default name.

string

Optional description.

Response

object

Show properties

string (uuid)

Unique vault identifier

string

Vault name

string | null

Vault description, or null if unset

'owner' | 'editor' | 'viewer'

Caller’s role in this vault: owner (manage members and settings), editor (add documents and edit extracted data), or viewer (read and annotate). A vault the caller reaches only through organization-wide visibility reports viewer. The role is not the whole story for writes: adding documents also needs the organization-level permission to manage vaults, so a caller can hold editor here and still receive 403 from POST /vaults/{id}/documents.

boolean

When true, only vault members can see the vault. When false, any member of the organization with organization-wide vault read can see it.

number

Documents that have finished scanning in this vault. Documents still being read are not counted yet.

string | null

ISO 8601 timestamp when guided setup finished, or null while the vault is still in setup. Documents added to a vault in setup are stored but not scanned until setup finishes. Vaults created through POST /vaults finish setup immediately, so this is always set for them.

string | null

ISO 8601 timestamp when the vault was archived, or null while it is live. Archived vaults are hidden from the default list and reject changes until POST /vaults/{id}/restore runs.

string

ISO 8601 creation timestamp

string

ISO 8601 last-update timestamp

REST

MCP

CLI

Create vault

Input parameters

Response

​Input parameters

​Response

Input parameters

Response