My Project
  1. Models
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
        POST
      • Get All the models
        GET
      • Getting the child models of a parent
        GET
      • Fetching models based on user role
        GET
      • Clone model by root model Id
        GET
      • Generate Model through AI by Uploading Image for specific trained models
        POST
      • Fetching the model Attributes
        GET
      • Deleting the attributes
        DELETE
      • Fetching a particular model by Id
        GET
      • Creating the Model Attributes
        POST
      • Deleting A Model By Id
        DELETE
      • Updating a Model by Id
        PUT
      • Creating the model Annotations
        POST
      • Updating the model annotation
        PUT
      • Deleting the Model annotation
        DELETE
      • fetching the model annotations
        GET
      • Fetching the Model Components
        GET
      • Saving completion status for models
        POST
    • 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
      • 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
    • 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. Models

Create the Model

Developing
POST
/model/
This API endpoint allows you to create a new model by submitting the model name, description, and a list of attributes. It accepts a JSON payload and returns a confirmation with the generated model ID.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/model/' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PickModel": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the model (CUID)"
      },
      "name": {
        "type": "string",
        "description": "Name of the pick model"
      },
      "type": {
        "type": "string",
        "description": "Type of the pick model"
      },
      "imageUrl": {
        "type": "string",
        "nullable": true,
        "description": "URL of the model image"
      },
      "iconName": {
        "type": "string",
        "nullable": true,
        "description": "Name of the icon for UI representation"
      },
      "description": {
        "type": "string",
        "nullable": true,
        "description": "Description of the model"
      },
      "superStructureId": {
        "type": "string",
        "nullable": true,
        "description": "ID of the associated super structure"
      },
      "subStructureId": {
        "type": "string",
        "nullable": true,
        "description": "ID of the associated sub structure"
      },
      "parentModelId": {
        "type": "string",
        "nullable": true,
        "description": "ID of the parent model"
      },
      "rootModelId": {
        "type": "string",
        "nullable": true,
        "description": "ID of the root model"
      },
      "organizationId": {
        "type": "string",
        "nullable": true,
        "description": "ID of the organization"
      },
      "completedLevel": {
        "type": "number",
        "format": "float",
        "nullable": true,
        "description": "Completion level of the model"
      },
      "isRoot": {
        "type": "boolean",
        "default": false,
        "description": "Indicates if this is a root model"
      },
      "createdById": {
        "type": "string",
        "nullable": true,
        "description": "User ID who created the model"
      },
      "createdAt": {
        "type": "string",
        "format": "date-time",
        "description": "Timestamp when the model was created"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time",
        "description": "Timestamp when the model was last updated"
      },
      "isArchived": {
        "type": "boolean",
        "default": false,
        "description": "Indicates if the model is archived"
      },
      "isDeleted": {
        "type": "boolean",
        "default": false,
        "description": "Indicates if the model is deleted"
      },
      "status": {
        "type": "string",
        "nullable": true,
        "default": "active",
        "description": "Status of the model (e.g., active, inactive)"
      },
      "projectModel": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Linked project models"
      },
      "superStructure": {
        "type": "object",
        "nullable": true,
        "description": "Related super structure entity"
      },
      "createdBy": {
        "type": "object",
        "nullable": true,
        "description": "User who created the model"
      },
      "attributes": {
        "type": "array",
        "items": { "type": "object" },
        "description": "List of attributes for the model"
      },
      "templates": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Associated templates"
      },
      "parentModel": {
        "type": "object",
        "nullable": true,
        "description": "Reference to the parent model"
      },
      "rootModel": {
        "type": "object",
        "nullable": true,
        "description": "Reference to the root model"
      },
      "childModels": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Child models in the hierarchy"
      },
      "rootModels": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Models that consider this as root"
      },
      "configurations": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Configurations associated with the model"
      },
      "configurationPickModels": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Pick models part of configurations"
      },
      "subStructure": {
        "type": "object",
        "nullable": true,
        "description": "Related sub structure entity"
      },
      "Notification": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Notifications related to this model"
      },
      "components": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Components associated with the model"
      },
      "parentComponents": {
        "type": "array",
        "items": { "type": "object" },
        "description": "Parent components of the model"
      },
      "organization": {
        "type": "object",
        "nullable": true,
        "description": "Organization that owns this model"
      }
    }
  }
}'
Response Response Example
{}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
PickModel
object 
required
type
string 
required
properties
object 
required
Examples

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2025-06-02 14:20:26
Previous
Models
Next
Get All the models
Built with