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

# Retrieve a sandbox twin

> With `wait_for`, the answer is held until the twin reaches that state, a run of it settles, or the wait runs out — so a caller waiting for a twin to serve sends one request rather than polling.



## OpenAPI

````yaml https://api.twinbay.ai/openapi.json get /sandboxes/{sandbox_id}/twins/{sandbox_twin_id}
openapi: 3.1.0
info:
  title: Twinbay
  description: Backend API
  version: 0.1.0
servers:
  - url: https://api.twinbay.ai
    description: Production
security: []
tags:
  - name: healthchecks
    description: Healthcheck endpoints
  - name: users
    description: >-
      The current user. Sign-up and sign-in happen in WorkOS AuthKit, which
      issues the access tokens this API accepts.
  - name: organizations
    description: >-
      Organizations the caller belongs to. Every authenticated request acts
      inside exactly one organization — the one its access token names — so
      these routes address it as `current`.
  - name: api-keys
    description: >-
      Long-lived credentials for callers that cannot hold an AuthKit session —
      agents, SDKs, CI. A key is accepted wherever an access token is, and acts
      with the role its creator holds when the request arrives.
  - name: sandboxes
    description: >-
      Create and edit isolated provider sandboxes. Each sandbox contains
      behavioural twins from the `twins` package.
  - name: twins
    description: Browse the digital twins available for new sandboxes.
paths:
  /sandboxes/{sandbox_id}/twins/{sandbox_twin_id}:
    get:
      tags:
        - sandboxes
      summary: Retrieve a sandbox twin
      description: >-
        With `wait_for`, the answer is held until the twin reaches that state, a
        run of it settles, or the wait runs out — so a caller waiting for a twin
        to serve sends one request rather than polling.
      operationId: get_sandbox_twin
      parameters:
        - name: sandbox_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Sandbox Id
        - name: sandbox_twin_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Sandbox Twin Id
        - name: wait_for
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - ready
                  - stopped
                type: string
              - type: 'null'
            title: Wait For
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxTwinResponse'
        '401':
          description: The credential is missing, malformed, expired, or not trusted
        '403':
          description: The credential does not act inside an organization
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - Access token: []
        - Organization API key: []
components:
  schemas:
    SandboxTwinResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        twin_slug:
          type: string
          title: Twin Slug
        twin_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Twin Version
          description: The release the current container was started from.
        desired_state:
          type: string
          title: Desired State
          description: running or stopped
        state:
          type: string
          title: State
          description: >-
            What the twin is actually doing: pending, provisioning, starting,
            ready, stopping, stopped or failed.
        url:
          type: string
          title: Url
        failure:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure
          description: Why the current run is not serving, if it is not.
        created_at:
          type: string
          format: date-time
          title: Created At
        ready_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ready At
      type: object
      required:
        - id
        - twin_slug
        - desired_state
        - state
        - url
        - created_at
      title: SandboxTwinResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    Access token:
      type: http
      description: Access token issued by WorkOS AuthKit.
      scheme: bearer
    Organization API key:
      type: apiKey
      description: >-
        An organization API key, as minted by POST
        /organizations/current/api-keys.
      in: header
      name: X-API-Key

````