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": [
    "/SandboxTest",
    "/SandboxTest/Documents",
    "/SandboxTest/Documents/Reports",
    "/SandboxTest/Documents/Contracts",
    "/SandboxTest/Images",
    "/SandboxTest/Images/Photos",
    "/SandboxTest/Images/Graphics",
    "/SandboxTest/Projects",
    "/SandboxTest/Projects/ProjectA",
    "/SandboxTest/Projects/ProjectB",
    "/SandboxTest/Archives",
    "/SandboxTest/Templates",
    "/SandboxTest/Shared",
    "/SandboxTest/Backups"
  ],
  "files": [
    {
      "path": "/SandboxTest/README.txt",
      "content": "Welcome to the Klavis Sandbox Test Environment. This is a test workspace for file operations."
    },
    {
      "path": "/SandboxTest/Documents/meeting_notes.txt",
      "content": "Meeting Notes - 2025-01-15\\n\\n- Discussed Q1 objectives\\n- Reviewed project timeline\\n- Action items assigned"
    },
    {
      "path": "/SandboxTest/Documents/Reports/quarterly_report.txt",
      "content": "Q4 2024 Quarterly Report\\n\\nRevenue: $1.2M\\nExpenses: $800K\\nProfit: $400K\\n\\nKey highlights: Strong growth in enterprise segment."
    },
    {
      "path": "/SandboxTest/Documents/Reports/annual_summary.txt",
      "content": "Annual Summary 2024\\n\\nTotal revenue: $4.5M\\nYear-over-year growth: 35%\\nNew customers: 150"
    },
    {
      "path": "/SandboxTest/Documents/Contracts/client_agreement.txt",
      "content": "Client Service Agreement\\n\\nThis agreement is entered into on January 1, 2025\\nBetween: Klavis AI\\nAnd: Acme Corporation"
    },
    {
      "path": "/SandboxTest/Documents/Contracts/vendor_contract.txt",
      "content": "Vendor Service Contract\\n\\nContract ID: VC-2025-001\\nEffective Date: 2025-01-01\\nTerm: 12 months"
    },
    {
      "path": "/SandboxTest/Images/sample_image.txt",
      "content": "[Image placeholder: sample_image.jpg - Landscape photo]"
    },
    {
      "path": "/SandboxTest/Images/Photos/vacation_photo.txt",
      "content": "[Image placeholder: vacation_photo.jpg - Beach sunset]"
    },
    {
      "path": "/SandboxTest/Images/Graphics/logo_design.txt",
      "content": "[Image placeholder: logo_design.svg - Company logo vector]"
    },
    {
      "path": "/SandboxTest/Projects/ProjectA/project_plan.txt",
      "content": "Project A - Implementation Plan\\n\\nPhase 1: Requirements gathering (2 weeks)\\nPhase 2: Development (6 weeks)\\nPhase 3: Testing (2 weeks)\\nPhase 4: Deployment (1 week)"
    },
    {
      "path": "/SandboxTest/Projects/ProjectA/status.txt",
      "content": "Project A Status Update\\n\\nCurrent Phase: Phase 2 (Development)\\nProgress: 45% complete\\nNext milestone: Alpha release"
    },
    {
      "path": "/SandboxTest/Projects/ProjectB/specifications.txt",
      "content": "Project B Technical Specifications\\n\\nPlatform: Web-based\\nFramework: React + Node.js\\nDatabase: PostgreSQL\\nDeployment: AWS"
    },
    {
      "path": "/SandboxTest/Projects/ProjectB/timeline.txt",
      "content": "Project B Timeline\\n\\nStart Date: 2025-02-01\\nEstimated Completion: 2025-05-31\\nMilestones: 5 key deliverables"
    },
    {
      "path": "/SandboxTest/Archives/archive_2024.txt",
      "content": "Archived data from 2024 fiscal year. Contains completed projects and finalized documents."
    },
    {
      "path": "/SandboxTest/Templates/email_template.txt",
      "content": "Email Template\\n\\nSubject: [Topic]\\n\\nDear [Name],\\n\\n[Message body]\\n\\nBest regards,\\n[Your name]"
    },
    {
      "path": "/SandboxTest/Templates/report_template.txt",
      "content": "Report Template\\n\\n1. Executive Summary\\n2. Introduction\\n3. Findings\\n4. Recommendations\\n5. Conclusion"
    },
    {
      "path": "/SandboxTest/Shared/team_calendar.txt",
      "content": "Team Calendar - January 2025\\n\\nWeek 1: Sprint planning\\nWeek 2: Development\\nWeek 3: Code review\\nWeek 4: Sprint retrospective"
    },
    {
      "path": "/SandboxTest/Shared/resources.txt",
      "content": "Shared Resources\\n\\n- Design guidelines\\n- Code style guide\\n- Documentation templates\\n- Testing procedures"
    },
    {
      "path": "/SandboxTest/Backups/config_backup.txt",
      "content": "Configuration Backup\\n\\nBackup Date: 2025-01-15\\nSystem: Production\\nStatus: Complete\\nRetention: 90 days"
    },
    {
      "path": "/SandboxTest/notes.txt",
      "content": "General Notes\\n\\n- Remember to update documentation\\n- Schedule team sync meeting\\n- Review pending pull requests"
    }
  ]
}
'
{
  "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

Query Parameters

init_default_data
boolean
default:false

If true, use default test data for initialization

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,
error
message
string
required

Initialization result message

records_created
Records Created · object

Count of records created per object type