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

# List API Boxes

> Returns the workspace's API Boxes, newest first. Results can be filtered by status and Snapshot.



## OpenAPI

````yaml /openapi/simulation.yaml get /v1/apibox
openapi: 3.1.0
info:
  description: >-
    Start API Boxes, Web Boxes, MCP Boxes and Cloud Boxes from Snapshots.
    Authenticate every request with an API key sent as a Bearer token.
  title: Continuous API
  version: v1
servers:
  - description: Continuous production API.
    url: https://api.continuouslabs.ai
security: []
tags:
  - description: >-
      Start API Boxes from API Box Snapshots. Each API Box serves its Snapshot's
      API at its own endpoint, with its own state, in real time. Stop, start and
      delete them.
    name: apibox
    x-group: API Boxes
  - description: >-
      Build API Box Snapshots from an OpenAPI, WSDL or GraphQL document, or use
      the catalog's. API Boxes start from a ready Snapshot.
    name: apibox-snapshots
    x-group: API Box Snapshots
  - description: >-
      Start Web Boxes from Web Box Snapshots. Each Web Box serves its Snapshot's
      web app at a host of its own, with its own state, in real time. Stop,
      start and delete them.
    name: webbox
    x-group: Web Boxes
  - description: >-
      Build Web Box Snapshots from a vendor's live web app, or use the
      catalog's. Web Boxes start from a ready Snapshot.
    name: webbox-snapshots
    x-group: Web Box Snapshots
  - description: >-
      Start MCP Boxes from MCP Box Snapshots. Each MCP Box serves its Snapshot's
      tools over MCP in front of an API Box. Stop, start and delete them.
    name: mcpbox
    x-group: MCP Boxes
  - description: >-
      List, rename and delete the MCP Box Snapshots that Continuous publishes
      into your workspace. Each holds an MCP server's tools, built against an
      API Box Snapshot.
    name: mcpbox-snapshots
    x-group: MCP Box Snapshots
  - description: >-
      Create emulated cloud accounts from Cloud Box Snapshots, start and stop
      them, and manage their Keys and connections.
    name: cloudbox
    x-group: Cloud Boxes
  - description: >-
      Save a Cloud Box's state as a Snapshot that new Cloud Boxes start from,
      and inspect, rename or delete Snapshots.
    name: cloudbox-snapshots
    x-group: Cloud Box Snapshots
  - description: >-
      Deprecated. Use API Box for APIs and Web Box for web apps. Build
      Simulators from OpenAPI, WSDL or GraphQL documents, check or cancel a
      build, clone Simulators into other workspaces, and rename and delete
      Simulators.
    name: simulators
    x-group: Simulators
  - description: >-
      Deprecated. Use API Box for APIs and Web Box for web apps. Create
      Simulations from ready Simulators or Snapshots, then rename, stop, start,
      and delete them.
    name: simulations
    x-group: Simulations
  - description: >-
      Deprecated. Use API Box for APIs and Web Box for web apps. Save a running
      Simulation's state as a Snapshot, create Simulations from it, and rename
      and delete it.
    name: simulation-snapshots
    x-group: Simulation Snapshots
  - description: >-
      Store connections to real systems: a base URL, the header that carries the
      credential, and its value. The API never returns a value.
    name: credentials
    x-group: Credentials
paths:
  /v1/apibox:
    get:
      tags:
        - apibox
      summary: List API Boxes
      description: >-
        Returns the workspace's API Boxes, newest first. Results can be filtered
        by status and Snapshot.
      operationId: list-apiboxes
      parameters:
        - description: Only API Boxes with this status.
          explode: false
          in: query
          name: status
          schema:
            enum:
              - starting
              - running
              - stopping
              - stopped
            type: string
        - description: Only API Boxes started from this Snapshot.
          explode: false
          in: query
          name: snapshot_id
          schema:
            pattern: ^abs_[0-9A-HJKMNP-TV-Z]{26}$
            type: string
        - description: Page size. Values below 1 use 50. Values above 200 use 200.
          explode: false
          in: query
          name: limit
          schema:
            default: 50
            format: int64
            type: integer
        - description: Opaque next_cursor value from a previous page.
          explode: false
          in: query
          name: cursor
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAPIBoxesResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              examples:
                bad_request:
                  $ref: '#/components/examples/bad_request'
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          content:
            application/problem+json:
              examples:
                validation_list_limit:
                  $ref: '#/components/examples/validation_list_limit'
              schema:
                $ref: '#/components/schemas/Error'
          description: Unprocessable Entity
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          content:
            application/problem+json:
              examples:
                auth_provider_unavailable:
                  $ref: '#/components/examples/auth_provider_unavailable'
                internal_unavailable:
                  $ref: '#/components/examples/internal_unavailable'
              schema:
                $ref: '#/components/schemas/Error'
          description: Service Unavailable
      security:
        - apiKeyAuth: []
components:
  schemas:
    ListAPIBoxesResponse:
      additionalProperties: false
      properties:
        apiboxes:
          description: API Boxes in this page.
          items:
            $ref: '#/components/schemas/APIBox'
          type: array
        next_cursor:
          description: Cursor for the next page, or null.
          type:
            - string
            - 'null'
      required:
        - apiboxes
        - next_cursor
      type: object
    Error:
      additionalProperties: false
      properties:
        code:
          description: Stable machine-readable error code.
          minLength: 1
          type: string
        detail:
          description: Safe human-readable error detail.
          minLength: 1
          type: string
        validation:
          $ref: '#/components/schemas/SpecificationValidation'
          description: >-
            Safe specification diagnostics for a rejected build request, when
            available.
      required:
        - validation
        - code
        - detail
      type: object
    APIBox:
      additionalProperties: false
      properties:
        created_at:
          description: API Box creation time.
          format: date-time
          type: string
        endpoint:
          description: >-
            Base URL of the API Box's API. Send the API Box's token in
            X-Continuous-APIBox-Token.
          type: string
        error:
          $ref: '#/components/schemas/SimulatorError'
          description: Why its last run stopped without a stop request, or null.
        id:
          description: API Box ID.
          pattern: ^abx_[0-9A-HJKMNP-TV-Z]{26}$
          type: string
        include_sample_data:
          description: Whether the API Box started with the Snapshot's sample data.
          type: boolean
        metadata:
          description: Customer JSON metadata, or null.
        name:
          description: API Box name. The ID is its identity, and names need not be unique.
          maxLength: 128
          type: string
        snapshot_id:
          description: The API Box Snapshot it started from.
          pattern: ^abs_[0-9A-HJKMNP-TV-Z]{26}$
          type: string
        status:
          description: >-
            starting while its runtime boots; running while it serves requests;
            stopping while it saves its state; stopped when it holds no runtime.
            A start resumes the saved state.
          enum:
            - starting
            - running
            - stopping
            - stopped
          type: string
      required:
        - id
        - name
        - snapshot_id
        - status
        - endpoint
        - error
        - metadata
        - include_sample_data
        - created_at
      type: object
    SpecificationValidation:
      additionalProperties: false
      properties:
        issues:
          description: Specification validation problems. At most 20 are returned.
          items:
            $ref: '#/components/schemas/SpecificationIssue'
          maxItems: 20
          type: array
      required:
        - issues
      type:
        - object
        - 'null'
    SimulatorError:
      additionalProperties: false
      properties:
        agent_message:
          description: >-
            Plain-text explanation from the build agent when it could not
            continue, or the problems the check of the build's index found. At
            most 4096 UTF-8 bytes.
          maxLength: 4096
          type:
            - string
            - 'null'
        code:
          description: >-
            Stable Simulator build error code. live_credential_rejected is a
            build that waited at QA for its rejected live credentials and was
            not resumed within 7 days.
          enum:
            - build_failed
            - build_canceled
            - specification_validation_failed
            - live_credential_rejected
          type: string
        detail:
          description: Safe human-readable error detail.
          type: string
        reason:
          description: >-
            Bounded failure reason for selecting recovery guidance, or null when
            unavailable.
          enum:
            - canceled
            - specification_invalid
            - time_limit
            - service_unavailable
            - build_failed
            - null
          type:
            - string
            - 'null'
        validation:
          $ref: '#/components/schemas/SpecificationValidation'
          description: >-
            Specification validation details. Address these issues before
            building again.
      required:
        - agent_message
        - reason
        - validation
        - code
        - detail
      type:
        - object
        - 'null'
    SpecificationIssue:
      additionalProperties: false
      properties:
        code:
          description: Stable validation rule code.
          type: string
        kind:
          description: >-
            Whether the input is invalid, unsupported, incomplete, exceeds a
            build limit, or has no specific diagnosis.
          enum:
            - invalid
            - unsupported
            - incomplete
            - limit
            - unknown
          type: string
        location:
          description: Readable endpoint or field affected by this issue.
          maxLength: 512
          type: string
        message:
          description: What needs attention at this location.
          type: string
        operation:
          description: >-
            Affected operation ID or method and path, when available. Empty for
            document-level issues.
          maxLength: 243
          type: string
        suggestion:
          description: How to correct or address the problem.
          type: string
      required:
        - code
        - operation
        - location
        - kind
        - message
        - suggestion
      type: object
  examples:
    bad_request:
      value:
        code: bad_request
        detail: The cursor is invalid.
        validation: null
    validation_list_limit:
      value:
        code: validation
        detail: 'validation failed: invalid integer at query.limit'
        validation: null
    auth_provider_unavailable:
      value:
        code: auth_provider_unavailable
        detail: >-
          The authentication provider is unavailable. Retry the request after a
          short delay.
        validation: null
    internal_unavailable:
      value:
        code: internal_unavailable
        detail: >-
          The service is temporarily unavailable. Retry the request after a
          short delay.
        validation: null
    auth_invalid:
      value:
        code: auth_invalid
        detail: The authentication credential is invalid.
        validation: null
    auth_missing:
      value:
        code: auth_invalid
        detail: Authentication credentials are required.
        validation: null
    internal:
      value:
        code: internal
        detail: The server encountered an unexpected error.
        validation: null
  responses:
    Unauthorized:
      content:
        application/problem+json:
          examples:
            auth_invalid:
              $ref: '#/components/examples/auth_invalid'
            auth_missing:
              $ref: '#/components/examples/auth_missing'
          schema:
            $ref: '#/components/schemas/Error'
      description: Unauthorized
    InternalServerError:
      content:
        application/problem+json:
          examples:
            internal:
              $ref: '#/components/examples/internal'
          schema:
            $ref: '#/components/schemas/Error'
      description: Internal Server Error
  securitySchemes:
    apiKeyAuth:
      bearerFormat: Continuous API key
      description: >-
        Use a Continuous API key. Send it in the Authorization header as a
        Bearer token.
      scheme: bearer
      type: http

````

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