Skip to main content
POST
/
local-sandbox
/
{local_sandbox_id}
/
initialize
Initialize sandbox from your uploaded data
curl --request POST \
  --url https://api.klavis.ai/local-sandbox/{local_sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.klavis.ai/local-sandbox/{local_sandbox_id}/initialize"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.klavis.ai/local-sandbox/{local_sandbox_id}/initialize', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.klavis.ai/local-sandbox/{local_sandbox_id}/initialize', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "sandbox_id": "<string>",
  "message": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

local_sandbox_id
string
required

The local sandbox identifier

Query Parameters

region
enum<string>
default:us

GCS bucket region where the archive was uploaded. Must match the region used in the /upload-url call. Defaults to 'us'.

Available options:
us,
asia

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied,
error
message
string
required

Initialization result message