My Project
  1. Checklists
My Project
  • Start your Apidog journey
  • Standalone Mode
    • Models
      • Create the Model
      • Get All the models
      • Getting the child models of a parent
      • Fetching models based on user role
      • Clone model by root model Id
      • Generate Model through AI by Uploading Image for specific trained models
      • Fetching the model Attributes
      • Deleting the attributes
      • Fetching a particular model by Id
      • Creating the Model Attributes
      • Deleting A Model By Id
      • Updating a Model by Id
      • Creating the model Annotations
      • Updating the model annotation
      • Deleting the Model annotation
      • fetching the model annotations
      • Fetching the Model Components
      • Saving completion status for models
    • Projects
      • Fetching the project model components
      • Get the recent projects
      • Get the completed projects
      • Get the shared project
      • Fetching the projects
      • Creating the project
      • Fetching the project by project Id
      • Deleting the project by projectId
      • Updating the project by Id
      • Get project model
      • create project model
      • Get project Model
      • Delete Project Model
      • Update the project model
      • Skip the project model
      • Complete the project
      • Upload pdf for project model
      • Adding project model attribute
      • Get the project model component
      • Downloading pdf in project
      • Upload image and get url
      • Get project settings
    • Checklists
      • Creating the Checklist
      • Get project checklist
      • Create project checklist
      • Delete project checklist
      • Get All checklist by Project Id
      • Update project checklist
      • Reset project checklist
      • Getting the relevant checklists
      • Fetching the predefined checklists
      • Creating the predefined checklist
      • Updating the predefined checklist
      • Deleting the predefined checklist
      • Creating the checklist by uploading a csv
    • Analytics & Reporting
      • Get project analytics
      • Get project analytics data
    • Task Tracking
      • Get inspector availability
      • Create Inspector availability
      • Creating Bulk inspector availability
      • Update Inspector availability
  • Edge Mode
    • Models
      • Create the Model
      • Get All the models
      • Getting the child models of a parent
      • Fetching models based on user role
      • Clone model by root model Id
      • Generate Model through AI by Uploading Image for specific trained models
      • Fetching the model Attributes
      • Deleting the attributes
      • Fetching a particular model by Id
      • Creating the Model Attributes
      • Deleting A Model By Id
      • Updating a Model by Id
      • Creating the model Annotations
      • Updating the model annotation
      • Deleting the Model annotation
      • fetching the model annotations
      • Fetching the Model Components
      • Saving completion status for models
    • Projects
      • Fetching the project model components
      • Get the recent projects
      • Get the completed projects
      • Get the shared project
      • Fetching the projects
      • Creating the project
      • Fetching the project by project Id
      • Deleting the project by projectId
      • Updating the project by Id
      • Get project model
      • create project model
      • Get project Model
      • Delete Project Model
      • Update the project model
      • Skip the project model
      • Complete the project
      • Upload pdf for project model
      • Adding project model attribute
      • Get the project model component
      • Downloading pdf in project
      • Upload image and get url
      • Get project settings
    • Icon
      • Creating the Icon
      • Deleting the icon
      • Get the Icons
      • Updating the Icon
      • Fetch all icons
      • Uplaod an Icon
    • Templates
      • Get template
      • Create the Template
      • Get template attributes
      • Create Template attribute
      • Delete template attribute
      • Update template attribute
      • Get template
      • Delete a Template
      • Update a template
      • Create template header
      • Get all template headers
      • Update the template header
      • Delete template header
    • Checklists
      • Creating the Checklist
        POST
      • Get project checklist
        GET
      • Create project checklist
        POST
      • Delete project checklist
        DELETE
      • Get All checklist by Project Id
        GET
      • Update project checklist
        PUT
      • Reset project checklist
        POST
      • Getting the relevant checklists
        GET
      • Fetching the predefined checklists
        GET
      • Creating the predefined checklist
        POST
      • Updating the predefined checklist
        PUT
      • Deleting the predefined checklist
        DELETE
      • Creating the checklist by uploading a csv
        POST
    • Annotations
      • get the annotaion
      • get annotation by Id
      • Create the annotation
      • Saving annotation in canvas
      • Updating the Annotation
      • Delete annotation by page number
      • Delete annotation
      • Get annotations with component
    • Analytics & Reporting
      • Get project analytics
      • Get project analytics data
    • Project Management Tool
      • Get project access
      • Update project access
      • Get the project model access
      • Updating the project model access
      • Delete project access
      • Get project invitation
      • send project invitation
      • Validate project invitation
      • Project Invitation Accept
      • Cancel Project Invitation
    • Task Tracking
      • Get inspector availability
      • Create Inspector availability
      • Creating Bulk inspector availability
      • Update Inspector availability
    • Estimations And Analytics
      • Fetching the project estimations
      • Creating the project estimations
      • Fetching the project estimations analytics
      • Download the project estimation analytics
      • Updating the project estimations
      • Deleting the project estimation by Id
  1. Checklists

Creating the Checklist

Developing
POST
/model/bulk/{modelId}/component
Creates a checklist that can be linked to a model or used independently. The checklist consists of multiple items or tasks and can be used for validation, review, or completion tracking during workflows or model processing.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/model/bulk//component' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "object",
    "required": [
        "annotations"
    ],
    "properties": {
        "annotations": {
            "type": "array",
            "description": "List of components to create based on existing icons",
            "items": {
                "type": "object",
                "properties": {
                    "iconId": {
                        "type": "string",
                        "description": "ID of the icon to associate with this component",
                        "example": "icon_abc123"
                    },
                    "name": {
                        "type": "string",
                        "description": "Name of the component",
                        "example": "Front Suspension"
                    },
                    "imageUrl": {
                        "type": "string",
                        "description": "URL of the image representing this component",
                        "example": "https://cdn.example.com/images/suspension.png"
                    }
                },
                "required": [
                    "iconId",
                    "name",
                    "imageUrl"
                ]
            }
        }
    },
    "example": {
        "annotations": [
            {
                "iconId": "icon_engine_01",
                "name": "Engine Block",
                "imageUrl": "https://cdn.example.com/models/engine_block.jpg"
            },
            {
                "iconId": "icon_wheel_02",
                "name": "Front Wheel",
                "imageUrl": "https://cdn.example.com/models/front_wheel.jpg"
            }
        ]
    }
}'
Response Response Example
{}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
modelId
string 
required
Body Params application/json
object {0}
Examples

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2025-06-06 14:55:06
Previous
Delete template header
Next
Get project checklist
Built with