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

# Create an invitation

> Dashboard-facing; owner only. The response carries the raw token exactly once and no acceptance URL: the dashboard builds .../invitations/accept#token=... itself, because TApi does not know the dashboard's origin. A live invitation already addressed to the same address is 409 lifecycle_conflict; a personal organization is 400 validation_failed.




## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/organizations/{organization_id}/invites
openapi: 3.1.0
info:
  title: Bonya Compute REST API
  version: 0.1.0
  description: >
    Public REST and WebSocket surface on TApi behind Caddy. Non-2xx responses
    are RFC 9457 application/problem+json with a stable machine-readable code.
    WebSocket endpoints are HTTP GET upgrades; their options travel in the START
    frame, never in query strings.
servers:
  - url: https://api.bonya.ai
    description: Production
security:
  - personalApiKey: []
  - supabaseJwt: []
tags:
  - name: Sandboxes
    description: Create, look up, list, pause, fork, snapshot, and delete sandboxes.
  - name: Snapshots
    description: Named point-in-time copies of a sandbox that new sandboxes can start from.
  - name: Templates
    description: Saved, versioned launch configurations for sandboxes.
  - name: Registry Connections
    description: Credentials for pulling private container images.
  - name: Secrets
    description: Write-only secrets and secret sets injected into sandboxes and jobs.
  - name: Previews
    description: Expose a sandbox port as an HTTPS URL.
  - name: Exec
    description: Run a command in a sandbox, buffered or over a TTY.
  - name: Sessions
    description: Named, persistent command sessions that outlive a connection.
  - name: Filesystem
    description: Read, write, and manage files inside a sandbox.
  - name: Jobs
    description: Managed, tracked runs of a command or script.
  - name: Job Schedules
    description: Cron, interval, or one-shot timing wrapped around a job.
  - name: Organizations
    description: Organization membership, administration and usage reporting.
  - name: Invitations
    description: Invite members to an organization and accept invitations.
  - name: API Keys
    description: Personal API key management.
  - name: Device Login
    description: Browser-based login for the CLI.
paths:
  /v1/organizations/{organization_id}/invites:
    parameters:
      - $ref: '#/components/parameters/OrganizationID'
    post:
      tags:
        - Invitations
      summary: Create an invitation
      description: >
        Dashboard-facing; owner only. The response carries the raw token exactly
        once and no acceptance URL: the dashboard builds
        .../invitations/accept#token=... itself, because TApi does not know the
        dashboard's origin. A live invitation already addressed to the same
        address is 409 lifecycle_conflict; a personal organization is 400
        validation_failed.
      operationId: createInvite
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  format: email
                role:
                  $ref: '#/components/schemas/Role'
      responses:
        '201':
          description: Invitation created; body carries the token once
          content:
            application/json:
              schema:
                type: object
                required:
                  - invitation
                  - token
                properties:
                  invitation:
                    $ref: '#/components/schemas/Invitation'
                  token:
                    type: string
                    description: >
                      Shown exactly once. Belongs in the URL fragment of an
                      invite link, never in a path or query string.
        default:
          $ref: '#/components/responses/Problem'
      security:
        - supabaseJwt: []
components:
  parameters:
    OrganizationID:
      name: organization_id
      in: path
      required: true
      schema:
        type: string
  schemas:
    Role:
      type: string
      enum:
        - owner
        - member
        - billing
      default: member
      description: >-
        Custom roles are out of scope; the set is closed. billing is a
        restricted role that cannot manage members, invitations, or organization
        settings.
    Invitation:
      type: object
      required:
        - invitation_id
        - organization_id
        - email
        - role
        - invited_by_user_id
        - status
        - created_at
        - expires_at
      properties:
        invitation_id:
          type: string
        organization_id:
          type: string
        email:
          type: string
          format: email
        role:
          $ref: '#/components/schemas/Role'
        invited_by_user_id:
          type: string
        status:
          type: string
          enum:
            - live
            - expired
            - consumed
            - revoked
          description: >
            Derived lifecycle. Consumed and revoked outrank expiry, so an
            invitation that was used and later passed its expiry reads consumed.
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        consumed_at:
          type: string
          format: date-time
        consumed_by_user_id:
          type: string
        revoked_at:
          type: string
          format: date-time
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
  responses:
    Problem:
      description: RFC 9457 problem
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    personalApiKey:
      type: http
      scheme: bearer
      description: >-
        Personal byk_ API key; user-principal, resolved to a tenant by org
        context.
    supabaseJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Supabase-issued session JWT; required for org, invite, and key
        management.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.