> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acornops.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a copyable workspace invitation link



## OpenAPI

````yaml /openapi/control-plane-public.json post /api/v1/workspaces/{workspaceId}/invitations
openapi: 3.1.0
info:
  title: AcornOps Control Plane API
  version: 0.0.1-experimental.1
  description: >-
    Control plane API for workspaces, targets, Kubernetes clusters, virtual
    machines, sessions, runs, auth, and internal execution wiring.
servers:
  - url: https://api.acornops.dev
security: []
tags:
  - name: health
    description: Health and readiness endpoints.
  - name: auth
    description: >-
      OIDC, password, browser session, and external integration account link
      endpoints.
  - name: workspaces
    description: Workspace, target, Kubernetes cluster, and VM management endpoints.
  - name: webhooks
    description: Best-effort webhook subscription and delivery history endpoints.
  - name: sessions
    description: Session and message endpoints.
  - name: runs
    description: Run query, cancel, and stream endpoints.
  - name: workflows
    description: >-
      Workspace workflow definitions, schedules, sessions, and approval inbox
      endpoints.
  - name: agents
    description: >-
      Workspace-scoped custom agent definitions, triggers, versions, tests, and
      activity.
  - name: admin
    description: Operator-only admin API protected exclusively by admin bearer tokens.
  - name: internal
    description: Internal execution endpoints for execution-engine.
paths:
  /api/v1/workspaces/{workspaceId}/invitations:
    post:
      tags:
        - workspaces
      summary: Create a copyable workspace invitation link
      parameters:
        - in: path
          name: workspaceId
          required: true
          schema:
            type: string
            format: uuid
            example: 4b930d98-add9-4924-ab26-3c16d96ec373
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
                - role
              properties:
                email:
                  type: string
                  format: email
                  example: sre@example.com
                role:
                  type: string
                  pattern: ^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$
                  description: >-
                    Deployment-supported workspace role key. Built-ins are
                    owner, admin, operator, viewer, and auditor; custom roles
                    are lowercase snake_case.
                expiresInDays:
                  type: integer
                  minimum: 1
                  maximum: 30
                  default: 7
      responses:
        '201':
          description: >-
            Invitation created. Response includes the raw token once and
            roleTemplate when the role is supported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceInvitationCreated'
        '400':
          description: >-
            ROLE_NOT_SUPPORTED when the role key is not in the
            deployment-supported catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Requires manage_members. PROTECTED_ROLE_REQUIRES_OWNER is returned
            when a non-owner assigns a protected role.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: User is already a member.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - userSession: []
components:
  schemas:
    WorkspaceInvitationCreated:
      allOf:
        - $ref: '#/components/schemas/WorkspaceInvitation'
      description: Invitation response. Includes the raw invitation token once.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details:
              type: object
              additionalProperties: true
              description: Optional structured error details.
    WorkspaceInvitation:
      type: object
      required:
        - id
        - workspaceId
        - email
        - role
        - status
      properties:
        id:
          type: string
          format: uuid
        workspaceId:
          type: string
          format: uuid
        email:
          type: string
          format: email
        role:
          type: string
        roleTemplate:
          $ref: '#/components/schemas/WorkspaceRoleTemplate'
        status:
          type: string
        token:
          type: string
          description: Returned only at creation time.
        expiresAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
      additionalProperties: true
    WorkspaceRoleTemplate:
      type: object
      required:
        - key
        - displayName
        - kind
        - capabilities
        - capabilityGroups
        - protected
        - sortOrder
      properties:
        key:
          type: string
        displayName:
          type: string
        description:
          type: string
        kind:
          type: string
          enum:
            - system
            - custom
        capabilities:
          type: array
          items:
            type: string
        capabilityGroups:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceRoleCapabilityGroup'
        protected:
          type: boolean
        sortOrder:
          type: integer
      additionalProperties: true
    WorkspaceRoleCapabilityGroup:
      type: object
      required:
        - key
        - capabilities
        - sortOrder
      properties:
        key:
          type: string
          enum:
            - workspace
            - members
            - targets
            - operations
            - settings
        capabilities:
          type: array
          items:
            type: string
        sortOrder:
          type: integer
      additionalProperties: true
  securitySchemes:
    userSession:
      type: apiKey
      in: cookie
      name: acornops_cp_session

````