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

# Acquire a sandbox

> Acquire an idle sandbox instance for a specific MCP server. The sandbox will be marked as 'occupied'. Optionally choose a benchmark (e.g., 'MCP_Atlas', 'Toolathlon') to configure the sandbox. IMPORTANT: The benchmark parameter may affect BOTH (1) the initial data environment (e.g., preloaded data for supported servers like Airtable, Notion, Slack, MongoDB) AND (2) the MCP server implementation itself — some servers are routed to a benchmark-specific MCP server URL (e.g., GitHub, Notion, Google Sheets). You may also specify a test_account_email to acquire a specific test account.



## OpenAPI

````yaml post /sandbox/{server_name}
openapi: 3.1.0
info:
  title: Klavis AI (https://www.klavis.ai)
  description: Klavis AI - Open Source MCP Integrations for AI Applications
  version: 0.1.0
servers:
  - url: https://api.klavis.ai
    description: US Production server
  - url: https://api.eu.klavis.ai
    description: EU Production server
security: []
paths:
  /sandbox/{server_name}:
    post:
      tags:
        - sandbox
      summary: Acquire a sandbox
      description: >-
        Acquire an idle sandbox instance for a specific MCP server. The sandbox
        will be marked as 'occupied'. Optionally choose a benchmark (e.g.,
        'MCP_Atlas', 'Toolathlon') to configure the sandbox. IMPORTANT: The
        benchmark parameter may affect BOTH (1) the initial data environment
        (e.g., preloaded data for supported servers like Airtable, Notion,
        Slack, MongoDB) AND (2) the MCP server implementation itself — some
        servers are routed to a benchmark-specific MCP server URL (e.g., GitHub,
        Notion, Google Sheets). You may also specify a test_account_email to
        acquire a specific test account.
      operationId: create_sandbox_sandbox__server_name__post
      parameters:
        - name: server_name
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SandboxMCPServer'
            description: The MCP server name
          description: The MCP server name
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcquireSandboxRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSandboxResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SandboxMCPServer:
      type: string
      enum:
        - jira
        - github
        - salesforce
        - hubspot
        - notion
        - airtable
        - linear
        - asana
        - google_sheets
        - google_drive
        - google_docs
        - gmail
        - google_calendar
        - google_forms
        - clickup
        - close
        - monday
        - motion
        - onedrive
        - microsoft_teams
        - outlook_mail
        - cal.com
        - quickbooks
        - moneybird
        - dropbox
        - shopify
        - woocommerce
        - outlook_calendar
        - resend
        - wordpress
        - mem0
        - supabase
        - slack
        - confluence
        - discord
        - snowflake
        - postgres
        - mongodb
        - youtube
        - googleworkspaceatlas
        - huggingface
        - mock_notion
        - arxiv_latex
        - calculator
        - clinicaltrialsgov
        - fetch
        - met_museum
        - open_library
        - osm
        - pubmed
        - us_weather
        - duckduckgo
        - whois
        - wikipedia
        - scholarly
        - howtocook
        - yahoo_finance
        - '12306'
        - youtube_transcript
        - weather
        - twelvedata
        - national_parks
        - lara_translate
        - e2b
        - context7
        - alchemy
        - weights_and_biases
        - oxylabs
        - google_maps
        - brave_search
        - exa
        - serper
      title: SandboxMCPServer
      description: Supported MCP servers for sandboxing
    AcquireSandboxRequest:
      properties:
        benchmark:
          anyOf:
            - $ref: '#/components/schemas/BenchmarkEnum'
            - type: 'null'
          description: >-
            Optional benchmark to configure the sandbox. NOTE: This parameter
            may affect BOTH (1) the initial data environment (preloaded data for
            supported servers) AND (2) the MCP server implementation (some
            servers are routed to a benchmark-specific MCP server URL with
            potentially different tools or behaviors).
        test_account_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Test Account Email
          description: >-
            Optional email of a specific test account to acquire. If provided,
            the system will attempt to acquire the sandbox associated with this
            test account email instead of a random idle sandbox.
        tag:
          anyOf:
            - type: string
            - type: 'null'
          title: Tag
          description: >-
            Optional sandbox tag used when acquiring specific sandboxes. For
            mock_notion this is REQUIRED and names the template/category to
            clone (e.g. 'online_resume')
        ttl_seconds:
          anyOf:
            - type: integer
              maximum: 86400
              minimum: 60
            - type: 'null'
          title: Ttl Seconds
          description: >-
            TTL in seconds. The sandbox will be automatically released after
            this duration. Default: 7200 (2 hours). Min: 60 (1 minute). Max:
            86400 (24 hours). Set to null to disable auto-release.
          default: 7200
      type: object
      title: AcquireSandboxRequest
      description: Request model for acquiring a sandbox
    CreateSandboxResponse:
      properties:
        sandbox_id:
          type: string
          title: Sandbox Id
          description: Unique identifier for the acquired sandbox
        server_urls:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Server Urls
          description: MCP server URLs keyed by server name
        server_name:
          $ref: '#/components/schemas/SandboxMCPServer'
          description: The MCP server name
        status:
          $ref: '#/components/schemas/SandboxStatus'
          description: Current status of the sandbox
        message:
          type: string
          title: Message
          description: Status message
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: 'Per-server extras. For now only mock_notion: { task_page_id: str }. '
      type: object
      required:
        - sandbox_id
        - server_name
        - status
        - message
      title: CreateSandboxResponse
      description: Response model for sandbox acquisition
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BenchmarkEnum:
      type: string
      enum:
        - MCP_Atlas
        - Toolathlon
        - MCP_Mark
      title: BenchmarkEnum
      description: Supported benchmarks for sandbox initial environment
    SandboxStatus:
      type: string
      enum:
        - idle
        - occupied
        - error
      title: SandboxStatus
      description: Status of a sandbox instance - matches database enum
    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:
    HTTPBearer:
      type: http
      description: Your Klavis AI API key.
      scheme: bearer
      x-fern-bearer:
        name: api_key

````