> ## 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 a session

> Keyed by name. Creating over a live session returns 409 session_exists; replace only applies to a terminal (already-exited) session, never a running or attached one.



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/sandbox/{sandbox_id}/sessions
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/sandbox/{sandbox_id}/sessions:
    parameters:
      - $ref: '#/components/parameters/SandboxID'
      - $ref: '#/components/parameters/OrganizationHeader'
    post:
      tags:
        - Sessions
      summary: Create a session
      description: >-
        Keyed by name. Creating over a live session returns 409 session_exists;
        replace only applies to a terminal (already-exited) session, never a
        running or attached one.
      operationId: createSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionCreateRequest'
      responses:
        '201':
          description: Session created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
        default:
          $ref: '#/components/responses/Problem'
components:
  parameters:
    SandboxID:
      name: sandbox_id
      in: path
      required: true
      schema:
        type: string
    OrganizationHeader:
      name: X-Bonya-Organization-ID
      in: header
      required: false
      schema:
        type: string
      description: >
        Org context. Omitted means the caller's personal organization. A
        well-formed non-member org is 404; malformed is 400.
  schemas:
    SessionCreateRequest:
      allOf:
        - $ref: '#/components/schemas/CommandSpec'
        - type: object
          required:
            - name
          properties:
            name:
              type: string
              pattern: ^[a-z][a-z0-9-]{0,31}$
            cols:
              type: integer
              minimum: 1
              maximum: 512
            rows:
              type: integer
              minimum: 1
              maximum: 512
            replace:
              type: boolean
              default: false
    SessionResponse:
      type: object
      required:
        - session
      properties:
        session:
          $ref: '#/components/schemas/SessionInfo'
    CommandSpec:
      type: object
      required:
        - command
      properties:
        command:
          type: array
          items:
            type: string
          minItems: 1
        env:
          type: object
          additionalProperties:
            type: string
        working_dir:
          type: string
    SessionInfo:
      type: object
      required:
        - name
        - command
        - working_dir
        - status
        - attached
        - started_at_unix_nanos
        - last_activity_unix_nanos
      properties:
        name:
          type: string
          pattern: ^[a-z][a-z0-9-]{0,31}$
        command:
          type: array
          items:
            type: string
        working_dir:
          type: string
        status:
          type: string
          enum:
            - unspecified
            - starting
            - idle
            - attached
            - exited
            - killed
            - failed
        attached:
          type: boolean
        started_at_unix_nanos:
          type: integer
        last_activity_unix_nanos:
          type: integer
        ended_at_unix_nanos:
          type: integer
        exit:
          $ref: '#/components/schemas/SessionExit'
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
    SessionExit:
      type: object
      required:
        - exit_code
        - signaled
        - signal
      properties:
        exit_code:
          type: integer
        signaled:
          type: boolean
        signal:
          type: integer
  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.