Skip to main content
POST
/
sandbox
/
{server_name}
Acquire a sandbox
curl --request POST \
  --url https://api.klavis.ai/sandbox/{server_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "test_account_email": "<string>"
}
'
{
  "sandbox_id": "<string>",
  "server_url": "<string>",
  "server_name": "jira",
  "status": "idle",
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

​
server_name
enum<string>
required

The MCP server name

Available options:
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,
outlook_calendar,
resend,
wordpress,
mem0,
supabase,
slack,
confluence,
discord,
snowflake,
google_cloud

Body

application/json

Request model for acquiring a sandbox

​
test_account_email
string | null

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.

Response

Successful Response

Response model for sandbox acquisition

​
sandbox_id
string
required

Unique identifier for the acquired sandbox

​
server_url
string
required

URL to connect to the MCP server

​
server_name
enum<string>
required

The MCP server name

Available options:
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,
outlook_calendar,
resend,
wordpress,
mem0,
supabase,
slack,
confluence,
discord,
snowflake,
google_cloud
​
status
enum<string>
required

Current status of the sandbox

Available options:
idle,
occupied
​
message
string
required

Status message