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

# Create Sandbox Connection

> Returns a short-lived WebSocket URL for an interactive shell in a
running sandbox. Connecting starts `/bin/sh` with a PTY. The connection
has no stored history or reconnect support.

The URL contains a signed token that expires at `expires_at`. An open
WebSocket can remain connected after the token expires. Clients send
input as `{"type":"input","data":"..."}` and terminal size changes as
`{"type":"resize","rows":24,"cols":80}`. The server returns terminal
output as text frames. Closing the WebSocket ends the shell. Pausing or
stopping the sandbox also closes the connection.




## OpenAPI

````yaml POST /api/sandboxes/{sid}/connections
openapi: 3.1.0
info:
  title: Archil Control Plane API
  description: >
    The Archil Control Plane API provides programmatic access to manage disks,

    persistent sandboxes, mounts, and API keys in the Archil distributed

    filesystem platform.


    API keys authenticate requests to this control plane and are scoped to

    your account. They are distinct from *disk tokens*, which are per-disk

    credentials used by clients when mounting a disk.


    ## Authentication


    All endpoints require an API key:


    ```

    Authorization: {API_KEY}

    ```


    Create API keys in the [Archil Console](https://console.archil.com) or via
    the API.


    ## Response Format


    All responses use a consistent envelope:


    ```json

    {
      "success": true,
      "data": { ... }
    }

    ```


    Or on error:


    ```json

    {
      "success": false,
      "error": "Error message"
    }

    ```
  version: 1.0.0
  contact:
    email: support@archil.com
    url: https://archil.com
servers:
  - url: https://control.green.us-east-1.aws.prod.archil.com
    description: AWS US East (N. Virginia) — aws-us-east-1
  - url: https://control.green.eu-west-1.aws.prod.archil.com
    description: AWS EU West (Ireland) — aws-eu-west-1
  - url: https://control.green.us-west-2.aws.prod.archil.com
    description: AWS US West (Oregon) — aws-us-west-2
  - url: https://control.blue.us-central1.gcp.prod.archil.com
    description: GCP US Central (Iowa) — gcp-us-central1
security:
  - ApiKeyAuth: []
tags:
  - name: Disks
    description: Create, read, update, and delete disks
  - name: Serverless Execution
    description: Run commands on a disk without provisioning compute
  - name: Sandboxes
    description: Manage persistent sandbox virtual machines
  - name: Disk Users
    description: Manage authorized users on disks
  - name: API Tokens
    description: >-
      Manage API keys (also called API tokens) used to authenticate Control
      Plane API requests. Distinct from disk tokens.
paths:
  /api/sandboxes/{sid}/connections:
    post:
      tags:
        - Sandboxes
      summary: Create a direct sandbox connection
      description: |
        Returns a short-lived WebSocket URL for an interactive shell in a
        running sandbox. Connecting starts `/bin/sh` with a PTY. The connection
        has no stored history or reconnect support.

        The URL contains a signed token that expires at `expires_at`. An open
        WebSocket can remain connected after the token expires. Clients send
        input as `{"type":"input","data":"..."}` and terminal size changes as
        `{"type":"resize","rows":24,"cols":80}`. The server returns terminal
        output as text frames. Closing the WebSocket ends the shell. Pausing or
        stopping the sandbox also closes the connection.
      operationId: createSandboxConnection
      parameters:
        - $ref: '#/components/parameters/SandboxId'
      responses:
        '200':
          description: A short-lived direct connection URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_SandboxConnection'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The sandbox is not running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    SandboxId:
      name: sid
      in: path
      required: true
      description: Sandbox UUID
      schema:
        type: string
        format: uuid
  schemas:
    ApiResponse_SandboxConnection:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/SandboxConnection'
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Invalid request parameters
    SandboxConnection:
      type: object
      required:
        - url
        - expires_at
      properties:
        url:
          type: string
          format: uri
        expires_at:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: Invalid or missing authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key

````