Skip to main content
POST
/
sandbox
/
clickup
/
{sandbox_id}
/
initialize
Initialize clickup sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/clickup/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spaces": [
    {
      "name": "<string>",
      "folders": [
        {
          "name": "<string>",
          "lists": [
            {
              "name": "<string>",
              "content": "<string>",
              "tasks": [
                {
                  "name": "<string>",
                  "description": "<string>",
                  "priority": 123,
                  "comments": [
                    {
                      "comment_text": "<string>"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "lists": [
        {
          "name": "<string>",
          "content": "<string>",
          "tasks": [
            {
              "name": "<string>",
              "description": "<string>",
              "priority": 123,
              "comments": [
                {
                  "comment_text": "<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 ClickUp sandbox data structure.

Nested hierarchy for initialization:

  • Spaces contain Folders and Lists (folderless)
  • Folders contain Lists
  • Lists contain Tasks
  • Tasks contain Comments
spaces
ClickUpSpace · object[] | null

List of spaces with nested objects

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