Skip to main content
POST
/
sandbox
/
dropbox
/
{sandbox_id}
/
initialize
Initialize dropbox sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/dropbox/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folders": [
    "<string>"
  ],
  "files": [
    {
      "path": "<string>",
      "content": "<string>"
    }
  ]
}
'
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Body

application/json

Complete Dropbox sandbox data structure

Describes the folder and file structure to be created in the sandbox. Folders are created in the order specified, and files are uploaded after all folders have been created.

Note: The root folder /SandboxTest is always created first automatically. Additional folders should be nested within /SandboxTest.

folders
string[] | null

List of folder paths to create (e.g., ['/SandboxTest', '/SandboxTest/Documents'])

files
DropboxFile · object[] | null

List of files to create with their content

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied
message
string
required

Initialization result message

records_created
Records Created · object

Count of records created per object type