Contract Intelligence

List vaults

List the Contract Intelligence vaults the caller can see: vaults they are a member of, plus organization-wide vaults when their role allows.

Use this to discover the vault_id for POST /chat/completions and POST /vaults/{id}/documents. Pass status=archived to list the archived vaults the caller owns.

Requires a user-scoped API key (u:gcai_...). A vault is shared with named people, so an organization-scoped key has no identity to resolve vault access with.

get/vaults

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/vaults/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Max items to return (default 100, max 500)

offsetinteger nullable

Number of items to skip (default 0)

searchstring

Case-insensitive substring match on vault name

status'active' | 'archived'

Which vaults to list. active (the default) returns live vaults. archived returns vaults the caller owns that have been archived, newest first, so they can be restored or deleted. Organization-wide visibility does not reach archived vaults, and only an owner can act on one, so the archived list is owner-only.

Response

Paginated list of vaults

Example response

{
  "vaults": [
    {
      "name": "Vendor SaaS agreements"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.