Initialize clickup sandbox with data

Initialize the sandbox with clickup-specific data following the defined schema.

POST /sandbox/clickup/{sandbox_id}/initialize

Initialize clickup sandbox with data

cURL

curl --request POST \
  --url https://api.klavis.ai/sandbox/clickup/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "spaces": [
    {
      "name": "Product Development Space",
      "folders": [
        {
          "name": "Engineering Projects",
          "lists": [
            {
              "name": "Backend Development",
              "description": "API and server-side development tasks",
              "tasks": [
                {
                  "name": "Implement user authentication API",
                  "description": "Create REST API endpoints for user login, registration, and password reset",
                  "priority": 1,
                  "comments": [
                    {
                      "body": "We should use OAuth2 with JWT tokens for better security"
                    },
                    {
                      "body": "Don't forget to implement rate limiting"
                    }
                  ]
                },
                {
                  "name": "Integrate payment gateway",
                  "description": "Integrate Stripe payment processing for subscription billing",
                  "priority": 1,
                  "comments": [
                    {
                      "body": "We need to handle webhook events for payment status updates"
                    }
                  ]
                },
                {
                  "name": "Optimize database queries",
                  "description": "Identify and optimize slow database queries, add appropriate indexes",
                  "priority": 2
                },
                {
                  "name": "Set up Redis caching",
                  "priority": 2
                }
              ]
            },
            {
              "name": "Frontend Development",
              "description": "UI/UX implementation tasks",
              "tasks": [
                {
                  "name": "Build responsive navigation component",
                  "description": "Implement responsive navigation menu with mobile hamburger menu support",
                  "priority": 3,
                  "comments": [
                    {
                      "body": "Consider using a CSS framework like Tailwind for faster development"
                    }
                  ]
                },
                {
                  "name": "Create onboarding flow",
                  "description": "Design and implement user onboarding flow with progress indicators",
                  "priority": 2
                },
                {
                  "name": "Fix layout bug on mobile",
                  "priority": 1,
                  "comments": [
                    {
                      "body": "Issue reported on iPhone 12 and 13"
                    },
                    {
                      "body": "Seems to be related to flexbox layout"
                    },
                    {
                      "body": "Fixed in dev branch, ready for testing"
                    }
                  ]
                }
              ]
            },
            {
              "name": "Mobile Development",
              "description": "iOS and Android app development",
              "tasks": [
                {
                  "name": "Implement push notifications",
                  "description": "Add push notification support for iOS and Android using Firebase",
                  "priority": 3
                },
                {
                  "name": "Update app icons",
                  "description": "Create and update app icons for all required sizes",
                  "priority": 4
                },
                {
                  "name": "Research biometric authentication"
                }
              ]
            },
            {
              "name": "Backlog",
              "tasks": []
            }
          ]
        },
        {
          "name": "Design & UX",
          "lists": [
            {
              "name": "Design Assets",
              "description": "Design mockups and assets",
              "tasks": [
                {
                  "name": "Design landing page mockups",
                  "description": "Create high-fidelity mockups for the new landing page with mobile and desktop variants",
                  "priority": 2,
                  "comments": [
                    {
                      "body": "Let's follow the existing design system for consistency"
                    }
                  ]
                },
                {
                  "name": "Create icon set",
                  "description": "Design custom icon set for the application",
                  "priority": 3
                }
              ]
            },
            {
              "name": "User Research",
              "description": "User testing and feedback",
              "tasks": [
                {
                  "name": "Conduct user interviews",
                  "description": "Interview 10 users about their experience with the product",
                  "priority": 2,
                  "comments": [
                    {
                      "body": "Schedule for next week"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "Quality Assurance",
          "lists": [
            {
              "name": "Testing & Bug Fixes",
              "description": "QA testing and bug tracking",
              "tasks": [
                {
                  "name": "Conduct accessibility audit",
                  "description": "Review and improve accessibility features to meet WCAG 2.1 AA standards",
                  "priority": 3
                },
                {
                  "name": "Write integration tests",
                  "priority": 2,
                  "comments": []
                },
                {
                  "name": "Load testing"
                }
              ]
            }
          ]
        },
        {
          "name": "Archive",
          "lists": []
        }
      ],
      "lists": [
        {
          "name": "DevOps & Infrastructure",
          "description": "Infrastructure and deployment tasks (folderless)",
          "tasks": [
            {
              "name": "Set up CI/CD pipeline",
              "description": "Configure automated testing and deployment pipeline using GitHub Actions",
              "priority": 2,
              "comments": [
                {
                  "body": "Make sure to include automated tests in the pipeline"
                }
              ]
            },
            {
              "name": "Write API documentation",
              "description": "Document all API endpoints with examples using OpenAPI/Swagger",
              "priority": 3
            },
            {
              "name": "Set up monitoring alerts",
              "priority": 1,
              "comments": [
                {
                  "body": "Use Datadog or similar"
                }
              ]
            }
          ]
        },
        {
          "name": "General Tasks",
          "tasks": [
            {
              "name": "Team standup meeting notes"
            }
          ]
        }
      ]
    },
    {
      "name": "Marketing & Sales Space",
      "folders": [
        {
          "name": "Campaigns",
          "lists": [
            {
              "name": "Q1 Campaign",
              "description": "First quarter marketing campaign",
              "tasks": [
                {
                  "name": "Create email templates",
                  "description": "Design and code responsive email templates",
                  "priority": 1
                },
                {
                  "name": "Social media content calendar",
                  "priority": 2,
                  "comments": [
                    {
                      "body": "Focus on LinkedIn and Twitter"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "lists": [
        {
          "name": "Sales Pipeline",
          "description": "Track sales opportunities",
          "tasks": [
            {
              "name": "Follow up with Enterprise Lead A",
              "description": "Schedule demo call",
              "priority": 1,
              "comments": [
                {
                  "body": "They requested custom pricing"
                }
              ]
            },
            {
              "name": "Prepare Q4 sales report"
            }
          ]
        }
      ]
    },
    {
      "name": "Personal Workspace",
      "folders": [],
      "lists": [
        {
          "name": "My Tasks",
          "tasks": [
            {
              "name": "Review code",
              "priority": 1
            }
          ]
        }
      ]
    }
  ]
}
EOF

200

{
  "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 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

Show child attributes

Response

200

application/json

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

Show child attributes