> ## 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 Member to a Vault > Give someone a role in a vault. Name them by `user_id` or by `email`, exactly one of the two. The person has to be a member of your organization already. An address that belongs to nobody in the organization returns `400` and nothing is sent, so this endpoint can never invite anyone or add a seat. Adding someone who already holds a role returns their existing row unchanged, current role included. That keeps a repeated call from quietly demoting an owner to `editor`. To change a role, use `PATCH /vaults/{id}/members/{userId}`. Requires the `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}/members 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}/members: post: tags: - Contract Intelligence summary: Add a member to a vault description: >- Give someone a role in a vault. Name them by `user_id` or by `email`, exactly one of the two. The person has to be a member of your organization already. An address that belongs to nobody in the organization returns `400` and nothing is sent, so this endpoint can never invite anyone or add a seat. Adding someone who already holds a role returns their existing row unchanged, current role included. That keeps a repeated call from quietly demoting an owner to `editor`. To change a role, use `PATCH /vaults/{id}/members/{userId}`. Requires the `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: addVaultMember 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/AddVaultMemberRequest' responses: '201': description: The vault member content: application/json: schema: $ref: '#/components/schemas/VaultMember' '400': description: Invalid request body, or user is not a member of this organization 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., or the caller is not a vault owner 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. Restore it with `POST /vaults/{id}/restore` before changing it. 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: AddVaultMemberRequest: type: object properties: user_id: type: integer minimum: 0 exclusiveMinimum: true description: >- GC AI user ID of the person to add, as `user_id` from `GET /vaults/{id}/members` or `id` from `GET /me`. Send this or `email`. email: type: string maxLength: 320 format: email description: >- Email address of the person to add. It has to belong to someone who is already a member of your organization. Send this or `user_id`. example: dana@example.com role: type: string enum: - owner - editor - viewer default: editor description: Role to grant. Defaults to `editor`. VaultMember: type: object properties: user_id: type: integer description: >- GC AI user ID of the member. This is the same identifier `GET /me` reports for the calling user, so a caller can pick their own row out of the list. email: type: string nullable: true description: Member email address, or null when the account has none on file. name: type: string nullable: true description: >- Member display name, preferring the name they chose for themselves. Null when the account has no name on file. role: type: string nullable: true enum: - owner - editor - viewer - null description: >- The member's role in this vault: `owner` (manage members and settings), `editor` (add documents and edit extracted data), or `viewer` (read and annotate). Null on the rare stored value GC AI cannot read as a role. Such a grant carries no permissions at all, so remove it and add the person again. added_at: type: string nullable: true description: >- ISO 8601 timestamp when the member was added, or null for grants written before GC AI recorded that. required: - user_id - email - name - role - added_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. ````