Skip to main content
POST
/
api
/
sandboxes
/
setup
cURL
curl --request POST \
  --url https://recoup-api.vercel.app/api/sandboxes/setup \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "status": "success",
  "runId": "run_abc123def456"
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Body

application/json

Optional account targeting parameters

​
account_id
string<uuid>

UUID of the account to set up the sandbox for. Only applicable for organization API keys - org keys can specify an account_id for any account within their organization. If not provided, sets up the sandbox for the API key's own account.

Response

Setup task triggered successfully

​
status
enum<string>
required

Status of the setup operation

Available options:
success
​
runId
string
required

The Trigger.dev run ID for the setup-sandbox background task. Use this with GET /api/tasks/runs to check the status and retrieve results.

Example:

"run_abc123def456"