> ## Documentation Index
> Fetch the complete documentation index at: https://www.klavis.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Initialize clickup sandbox with data

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



## OpenAPI

````yaml post /sandbox/clickup/{sandbox_id}/initialize
openapi: 3.1.0
info:
  title: Klavis AI (https://www.klavis.ai)
  description: Klavis AI - Open Source MCP Integrations for AI Applications
  version: 0.1.0
servers:
  - url: https://api.klavis.ai
    description: US Production server
  - url: https://api.eu.klavis.ai
    description: EU Production server
security: []
paths:
  /sandbox/clickup/{sandbox_id}/initialize:
    post:
      tags:
        - sandbox
      summary: Initialize clickup sandbox with data
      description: >-
        Initialize the sandbox with clickup-specific data following the defined
        schema.
      operationId: initialize_sandbox_sandbox_clickup__sandbox_id__initialize_post
      parameters:
        - name: sandbox_id
          in: path
          required: true
          schema:
            type: string
            description: The unique sandbox identifier
            title: Sandbox Id
          description: The unique sandbox identifier
        - name: init_default_data
          in: query
          required: false
          schema:
            type: boolean
            description: If true, use default test data for initialization
            default: false
            title: Init Default Data
          description: If true, use default test data for initialization
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/ClickUpData-Input'
                - type: 'null'
              title: Request Body
            examples:
              default:
                summary: Example initialization data
                value:
                  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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitializeSandboxResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ClickUpData-Input:
      properties:
        spaces:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClickUpSpace-Input'
              type: array
            - type: 'null'
          title: Spaces
          description: List of spaces with nested objects
      type: object
      title: ClickUpData
      description: |-
        Complete ClickUp sandbox data structure.

        Nested hierarchy for initialization:
        - Spaces contain Folders and Lists (folderless)
        - Folders contain Lists
        - Lists contain Tasks
        - Tasks contain Comments
    InitializeSandboxResponse:
      properties:
        sandbox_id:
          type: string
          title: Sandbox Id
          description: Sandbox identifier
        status:
          $ref: '#/components/schemas/SandboxStatus'
          description: Current status
        message:
          type: string
          title: Message
          description: Initialization result message
      type: object
      required:
        - sandbox_id
        - status
        - message
      title: InitializeSandboxResponse
      description: Response model for sandbox initialization
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ClickUpSpace-Input:
      properties:
        name:
          type: string
          title: Name
          description: Space name
        folders:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClickUpFolder-Input'
              type: array
            - type: 'null'
          title: Folders
          description: Folders in this space
        lists:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClickUpList-Input'
              type: array
            - type: 'null'
          title: Lists
          description: Folderless lists in this space
      type: object
      required:
        - name
      title: ClickUpSpace
      description: ClickUp Space object
    SandboxStatus:
      type: string
      enum:
        - idle
        - occupied
        - error
      title: SandboxStatus
      description: Status of a sandbox instance - matches database enum
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ClickUpFolder-Input:
      properties:
        name:
          type: string
          title: Name
          description: Folder name
        lists:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClickUpList-Input'
              type: array
            - type: 'null'
          title: Lists
          description: Lists in this folder
      type: object
      required:
        - name
      title: ClickUpFolder
      description: ClickUp Folder object
    ClickUpList-Input:
      properties:
        name:
          type: string
          title: Name
          description: List name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: List description
        tasks:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClickUpTask-Input'
              type: array
            - type: 'null'
          title: Tasks
          description: Tasks in this list
      type: object
      required:
        - name
      title: ClickUpList
      description: ClickUp List object
    ClickUpTask-Input:
      properties:
        name:
          type: string
          title: Name
          description: Task name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Task description
        priority:
          anyOf:
            - type: integer
            - type: 'null'
          title: Priority
          description: Task priority (1-4)
        comments:
          anyOf:
            - items:
                $ref: '#/components/schemas/ClickUpComment'
              type: array
            - type: 'null'
          title: Comments
          description: Comments on this task
      type: object
      required:
        - name
      title: ClickUpTask
      description: ClickUp Task object
    ClickUpComment:
      properties:
        body:
          type: string
          title: Body
          description: Comment body content
      type: object
      required:
        - body
      title: ClickUpComment
      description: ClickUp Comment object
  securitySchemes:
    HTTPBearer:
      type: http
      description: Your Klavis AI API key.
      scheme: bearer
      x-fern-bearer:
        name: api_key

````