> ## Documentation Index > Fetch the complete documentation index at: https://docs.gc.ai/llms.txt > Use this file to discover all available pages before exploring further. # Add a Column to a Vault > Add a column to a vault's table. Adding a column scans nothing. Documents already in the vault keep an empty cell for the new column until a re-scan fills it, which you start from the vault in the app. Add the columns you want before you upload, and every document that arrives afterwards is read against all of them. The new column starts hidden in every saved view of this vault. A saved view is a sharing boundary, so a column created after the view was saved never joins it on its own; a member of the view reveals it there when they want it. `field_key` is frozen at creation. Omit it and GC AI builds one from the label. Renaming the column later leaves the key alone, so the values already extracted stay attached to it. A vault holds at most 500 columns. Column 501 returns `403` with the message the app shows, and you have to delete a column before adding another. Requires the `editor` or `owner` role in the vault and the organization-level permission to manage vaults. 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. ## OpenAPI ````yaml POST /vaults/{id}/columns openapi: 3.0.3 info: title: GC AI External API version: 1.0.0 description: >- The GC AI External API allows programmatic access to GC AI's chat capabilities. It's designed for integration with workflow automation tools like Zapier, Make, n8n, or custom applications. ## Authentication All API requests must include an API key in the `Authorization` header: ``` Authorization: gcai_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` API keys can be created in the GC AI app under **Settings → API**. ## Multi-turn Conversations Conversations can span multiple turns: pass the `chat_id` returned by a completion back on your next request to continue the same chat. See [Multi-turn Conversations](/api-reference/concepts/multi-turn). ## Current Limitations The following is not yet available via API: - **Interactive clarification**: the model cannot pause to ask the caller a follow-up question; the `askUserQuestions` tool is disabled on the API surface ## Usage Usage is tracked and viewable in the GC AI app under **Settings → API → View Usage**. ## Support For API support, contact [support@gc.ai](mailto:support@gc.ai) or reach out to your account representative. contact: email: support@gc.ai servers: - url: https://app.gc.ai/api/external/v1 description: Production server security: [] tags: - name: Async Jobs description: Poll the status and result of asynchronous API jobs - name: Chat description: AI chat completion endpoints - name: Chats description: Chat management, message history, and sharing endpoints - name: Contract Intelligence description: Vault discovery and document ingestion endpoints for Contract Intelligence - name: Files description: File upload and management endpoints - name: Folders description: Folder management endpoints - name: Playbooks description: Playbook review endpoints - name: Profiles description: Personal and company profile endpoints - name: Projects description: Project management endpoints - name: Skills description: Skill library management endpoints - name: Utility description: Health check and connectivity endpoints - name: Usage description: Usage and credit/billing reporting endpoints paths: /vaults/{id}/columns: post: tags: - Contract Intelligence summary: Add a column to a vault description: >- Add a column to a vault's table. Adding a column scans nothing. Documents already in the vault keep an empty cell for the new column until a re-scan fills it, which you start from the vault in the app. Add the columns you want before you upload, and every document that arrives afterwards is read against all of them. The new column starts hidden in every saved view of this vault. A saved view is a sharing boundary, so a column created after the view was saved never joins it on its own; a member of the view reveals it there when they want it. `field_key` is frozen at creation. Omit it and GC AI builds one from the label. Renaming the column later leaves the key alone, so the values already extracted stay attached to it. A vault holds at most 500 columns. Column 501 returns `403` with the message the app shows, and you have to delete a column before adding another. Requires the `editor` or `owner` role in the vault and the organization-level permission to manage vaults. 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. operationId: createVaultColumn parameters: - schema: type: string format: uuid description: The vault ID required: true description: The vault ID name: id in: path requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateVaultColumnRequest' responses: '201': description: The created column content: application/json: schema: $ref: '#/components/schemas/VaultColumnResponse' '400': description: >- Invalid request body, a `field_key` that is reserved, underivable, or holds a control character, an option list that is not 2 to 12 unique values, or an `ai` column with no instructions content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or malformed API key content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Contract Intelligence is not enabled for this account. Contact support to request access., the caller cannot manage this vault's columns, or the vault has reached its 500 column limit content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Vault not found or access denied content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- The vault is archived, or a column with that `field_key` already exists content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- Vault access is per-user and requires a user-scoped API key (u:gcai_...). content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Rate limit exceeded. See [Rate Limits](/api-reference/concepts/rate-limits) for the tiers, limits, and how to back off. headers: Retry-After: schema: type: string description: Seconds to wait before retrying after a rate-limit block. example: '60' required: true description: Seconds to wait before retrying after a rate-limit block. RateLimit-Limit: schema: type: string description: Request quota for the applicable window. example: '3' required: true description: Request quota for the applicable window. RateLimit-Remaining: schema: type: string description: Requests remaining in the current window. example: '0' required: true description: Requests remaining in the current window. RateLimit-Reset: schema: type: string description: Seconds until the quota resets. example: '60' required: true description: Seconds until the quota resets. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Service temporarily unavailable headers: Retry-After: schema: type: string description: >- Seconds to wait before retrying after a transient service outage. example: '5' required: true description: >- Seconds to wait before retrying after a transient service outage. content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: [] components: schemas: CreateVaultColumnRequest: type: object properties: label: type: string minLength: 1 maxLength: 200 description: The column heading shown in the vault table. example: Renewal notice field_key: type: string minLength: 1 maxLength: 100 description: >- The key extracted values are stored under. Omit it and GC AI builds one from the label (`Renewal notice` becomes `renewalNotice`). Set it when you need the key to match something you already store, because the key is frozen once the column exists: renaming the column later never changes it. Any printable key up to 100 characters works, including one with an underscore or a hyphen; percent-encode it when you address a cell on this column. example: renewalNotice instructions: type: string maxLength: 4000 default: '' description: >- Required for an `ai` column: this text is the prompt extraction reads each document with, so say what to look for and what to return. Optional for a `manual` column, where it is only a note to whoever fills the column in. example: >- Extract the number of days notice required to avoid automatic renewal. Return the number of days only. field_type: type: string enum: - text - date - date_range - enum - multi_enum - boolean - number - currency - percentage - duration - email - url - list - rich_text default: text description: >- The shape of the values in this column. `enum` and `multi_enum` need `field_meta`; every other type needs `field_meta: null`. field_meta: oneOf: - type: object properties: type: type: string enum: - enum options: type: array items: type: string minLength: 1 maxLength: 200 description: >- The values this column can hold. Between 2 and 12, all different. example: - Renewal - New business - Amendment required: - type - options - type: object properties: type: type: string enum: - multi_enum options: type: array items: type: string minLength: 1 maxLength: 200 description: >- The values this column can hold. Between 2 and 12, all different. A document can carry more than one. required: - type - options - nullable: true default: null description: >- The option list for an `enum` or `multi_enum` column. Send `null`, or omit it, for every other type. extraction_mode: type: string enum: - ai - manual default: ai description: >- How the column gets filled. `ai` (the default) has extraction read it out of each document. `manual` keeps it out of every scan so the values stay exactly what a person types. sort_order: type: integer description: >- Placement weight, 0 by default. The table orders columns by `sort_order` first and creation time second, so columns added without one keep the order you added them in. required: - label VaultColumnResponse: type: object properties: id: type: string nullable: true format: uuid description: >- Unique column identifier, or null for a built-in column. A built-in column has no row of its own in this vault, so it has no ID and cannot be changed or deleted. field_key: type: string description: >- The stable key extracted values are stored under. It is set once, when the column is created, and never changes, so renaming the column keeps every value already extracted for it. example: renewalNotice label: type: string description: The column heading shown in the vault table example: Renewal notice instructions: type: string description: >- For an `ai` column, the prompt extraction reads each document with. For a `manual` or `import` column, a note to whoever reads the column. field_type: type: string enum: - text - date - date_range - enum - multi_enum - boolean - number - currency - percentage - duration - email - url - list - rich_text - party_list - related_agreement_list description: >- The shape of the values in this column. Built-in columns can report `party_list` and `related_agreement_list`, which you cannot set yourself. field_meta: oneOf: - type: object properties: type: type: string enum: - enum options: type: array items: type: string minLength: 1 maxLength: 200 description: The values extraction can assign to this column. legacy_options: type: array items: type: string minLength: 1 maxLength: 200 description: >- Values that documents extracted under an older version of this option list still hold. They stay readable and filterable, and extraction never assigns them again. required: - type - options - type: object properties: type: type: string enum: - multi_enum options: type: array items: type: string minLength: 1 maxLength: 200 description: The values extraction can assign to this column. required: - type - options - nullable: true description: >- The option list for an `enum` or `multi_enum` column. Null for every other type. extraction_mode: type: string enum: - ai - manual - import description: >- How the column gets filled. `ai`: extraction reads it out of each document. `manual`: a person types it and no scan ever touches it. `import`: values come from a connected spreadsheet, which owns the column. You can create `ai` and `manual` columns; an `import` column is created by connecting a spreadsheet in the app. kind: type: string enum: - built_in - system - custom description: >- What this column is. `built_in`: merged into every vault by GC AI, with no ID and no way to change it. `system`: owned by this vault but managed by GC AI (Document Name, Document Status, Document Title), so it has an ID but rejects every change and every delete. `custom`: yours, and the only kind `PATCH` and `DELETE` accept. editable: type: boolean description: >- True when this column can be changed with `PATCH /vaults/{id}/columns/{columnId}`. Built-in and system columns report `false`: GC AI owns their name, type, options, and prompt. One exception, on both surfaces: `sort_order` is list position rather than identity, so it can be set on any column that has an ID. sort_order: type: number nullable: true description: >- Placement weight for this column, or null for a built-in one. The table orders columns by `sort_order` first and creation time second. created_at: type: string nullable: true description: ISO 8601 creation timestamp, or null for a built-in column updated_at: type: string nullable: true description: ISO 8601 last-update timestamp, or null for a built-in column required: - id - field_key - label - instructions - field_type - field_meta - extraction_mode - kind - editable - sort_order - created_at - updated_at Error: type: object properties: error: type: string description: Error message code: type: string description: >- Machine-readable error code present on some errors (e.g. `RATE_LIMITED`, `INSUFFICIENT_CREDITS`, `TRIAL_NOT_STARTED`, `BILLING_NOT_CONFIGURED`). Branch on this rather than the human-readable `error` string. message: type: string description: Additional error details details: type: object additionalProperties: nullable: true description: Validation error details (for 400 errors) required: - error securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: |- API key for authentication. Format: `gcai_xxxxxxxxx` Create API keys in the GC AI app under Settings → API. ````