# My Project ## Docs - [Start your Apidog journey](https://g6ehnyblk1.apidog.io/start-your-apidog-journey-1054116m0.md): - Standalone Mode [Models](https://g6ehnyblk1.apidog.io/models-3955153f0.md): - Edge Mode [Models](https://g6ehnyblk1.apidog.io/models-3907569f0.md): ## API Docs - Standalone Mode > Models [Create the Model](https://g6ehnyblk1.apidog.io/create-the-model-17739023e0.md): 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. - Standalone Mode > Models [Get All the models ](https://g6ehnyblk1.apidog.io/get-all-the-models-17739024e0.md): This API retrieves a complete list of all models available in the system. It is typically used to display or manage the existing models in the frontend interface. The response includes model metadata such as model ID, name, creation date, and status. - Standalone Mode > Models [Getting the child models of a parent](https://g6ehnyblk1.apidog.io/getting-the-child-models-of-a-parent-17739025e0.md): This endpoint fetches all the child models linked to a specific parent model. It requires the parent model's ID as input and returns an array of child model objects. Useful in hierarchical or modular model structures where one model is composed of sub-models. - Standalone Mode > Models [Fetching models based on user role ](https://g6ehnyblk1.apidog.io/fetching-models-based-on-user-role-17739026e0.md): - Standalone Mode > Models [Clone model by root model Id](https://g6ehnyblk1.apidog.io/clone-model-by-root-model-id-17739027e0.md): This endpoint creates an exact copy of an existing model (the "root model") identified by its ID. The clone will include all associated metadata, structure, and attributes. Commonly used when building new models based on a previous template or configuration. - Standalone Mode > Models [Generate Model through AI by Uploading Image for specific trained models](https://g6ehnyblk1.apidog.io/generate-model-through-ai-by-uploading-image-for-specific-trained-models-17739028e0.md): This advanced endpoint allows users to upload an image, which is then processed using an AI/ML model trained to recognize specific features. Based on the image content, a model is auto-generated with attributes inferred from the image. Ideal for applications like product digitization, object modeling, etc. - Standalone Mode > Models [Fetching the model Attributes ](https://g6ehnyblk1.apidog.io/fetching-the-model-attributes-17739029e0.md): Fetches all the attributes or fields defined within a specific model. This includes each attribute’s name, type, default value (if any), and whether it is required or optional. Useful for displaying model structure or preparing forms dynamically. - Standalone Mode > Models [Deleting the attributes ](https://g6ehnyblk1.apidog.io/deleting-the-attributes-17739030e0.md): Deletes one or more attributes from an existing model. This operation requires the model ID and the attribute(s) to be deleted. Use with caution as removing attributes may affect linked data or system behavior. - Standalone Mode > Models [Fetching a particular model by Id](https://g6ehnyblk1.apidog.io/fetching-a-particular-model-by-id-17739031e0.md): Retrieves complete details of a specific model using its unique identifier. The response includes metadata, all attributes, and any linked configurations. Commonly used in model detail pages or edit interfaces. - Standalone Mode > Models [Creating the Model Attributes](https://g6ehnyblk1.apidog.io/creating-the-model-attributes-17739032e0.md): Allows the user to define and add new attributes (fields) to a model. Each attribute includes properties like name, data type, validation rules, and default values. Useful for customizing models to suit specific use cases. - Standalone Mode > Models [Deleting A Model By Id](https://g6ehnyblk1.apidog.io/deleting-a-model-by-id-17739033e0.md): Permanently deletes a model from the system using its ID. This action removes the model and all its associated attributes and data. Should be used only when the model is no longer needed, as this operation is irreversible. - Standalone Mode > Models [Updating a Model by Id](https://g6ehnyblk1.apidog.io/updating-a-model-by-id-17739034e0.md): Updates the details of an existing model using its ID. This may include changes to the model name, description, or structure. Partial or full updates are supported depending on the implementation. - Standalone Mode > Models [Creating the model Annotations](https://g6ehnyblk1.apidog.io/creating-the-model-annotations-17739035e0.md): Allows users to add annotations to a specific model. Annotations can include notes, comments, tags, or data insights that provide additional context or guidance related to the model’s content or structure. - Standalone Mode > Models [Updating the model annotation](https://g6ehnyblk1.apidog.io/updating-the-model-annotation-17739036e0.md): Updates an existing annotation on a model. The update may include changes to the annotation text, metadata, or associated tags. Useful when correcting or expanding on earlier notes. - Standalone Mode > Models [Deleting the Model annotation](https://g6ehnyblk1.apidog.io/deleting-the-model-annotation-17739037e0.md): Deletes a specific annotation from a model using its annotation ID. This is used to remove outdated, incorrect, or no longer needed notes from the model’s record. - Standalone Mode > Models [fetching the model annotations](https://g6ehnyblk1.apidog.io/fetching-the-model-annotations-17739038e0.md): Retrieves all annotations that have been added to a given model. This is useful for review, collaboration, or audit purposes to understand the history and context of modifications or decisions. - Standalone Mode > Models [Fetching the Model Components](https://g6ehnyblk1.apidog.io/fetching-the-model-components-17739039e0.md): Retrieves all components that are part of a given model. Components may include logical or physical units that make up the model's structure. Useful for understanding model decomposition and modular analysis. - Standalone Mode > Models [Saving completion status for models ](https://g6ehnyblk1.apidog.io/saving-completion-status-for-models-17739040e0.md): Save or update the current progress or completion percentage/status of one or multiple models under a project to track workflow stages. - Standalone Mode > Projects [Fetching the project model components ](https://g6ehnyblk1.apidog.io/fetching-the-project-model-components-17739047e0.md): Retrieves components associated with a specific project model. These may include structural units, modules, or parts tied to a larger project context. - Standalone Mode > Projects [Get the recent projects](https://g6ehnyblk1.apidog.io/get-the-recent-projects-17739048e0.md): Returns a list of the most recently accessed or created projects by the user. Helps users quickly resume work or monitor latest project activity. - Standalone Mode > Projects [Get the completed projects](https://g6ehnyblk1.apidog.io/get-the-completed-projects-17739049e0.md): Fetches all projects marked as completed or closed. This endpoint is useful for historical analysis, reporting, or archiving. - Standalone Mode > Projects [Get the shared project](https://g6ehnyblk1.apidog.io/get-the-shared-project-17739050e0.md): Retrieves all projects that have been explicitly shared with the current user by others. Shared projects may include view or edit access depending on permissions. - Standalone Mode > Projects [Fetching the projects](https://g6ehnyblk1.apidog.io/fetching-the-projects-17739051e0.md): Returns a comprehensive list of all projects accessible to the current user. Each project object includes details like ID, name, status, and creation date. - Standalone Mode > Projects [Creating the project](https://g6ehnyblk1.apidog.io/creating-the-project-17739052e0.md): Allows users to create a new project by providing basic metadata such as project name, description, owner, and optionally a template or team assignment. - Standalone Mode > Projects [Fetching the project by project Id](https://g6ehnyblk1.apidog.io/fetching-the-project-by-project-id-17739053e0.md): Retrieve comprehensive details about a specific project by providing its unique project ID. This includes metadata such as project name, description, status, associated users, and timestamps. - Standalone Mode > Projects [Deleting the project by projectId](https://g6ehnyblk1.apidog.io/deleting-the-project-by-projectid-17739054e0.md): Permanently remove a project from the system by specifying its project ID. This action deletes all associated data including models, annotations, and documents linked to the project. - Standalone Mode > Projects [Updating the project by Id](https://g6ehnyblk1.apidog.io/updating-the-project-by-id-17739055e0.md): Modify one or more attributes of an existing project identified by its ID. This could include changing the project name, description, deadline, status, or assigned team members. - Standalone Mode > Projects [Get project model](https://g6ehnyblk1.apidog.io/get-project-model-17739056e0.md): Fetch detailed information about a particular model within a project, including its attributes, current status, linked documents, and associated components. - Standalone Mode > Projects [create project model](https://g6ehnyblk1.apidog.io/create-project-model-17739057e0.md): Add a new model to a project, initializing its details and linking it to the parent project for tracking and management. - Standalone Mode > Projects [Get project Model](https://g6ehnyblk1.apidog.io/get-project-model-17739058e0.md): Fetch detailed information about a particular model within a project, including its attributes, current status, linked documents, and associated components. - Standalone Mode > Projects [Delete Project Model](https://g6ehnyblk1.apidog.io/delete-project-model-17739059e0.md): Remove a specified model and all related data such as components and attributes from the project permanently. - Standalone Mode > Projects [Update the project model](https://g6ehnyblk1.apidog.io/update-the-project-model-17739060e0.md): Update various properties or metadata of an existing project model, such as model name, description, parameters, or status. - Standalone Mode > Projects [Skip the project model](https://g6ehnyblk1.apidog.io/skip-the-project-model-17739061e0.md): Mark a project model as skipped in the workflow, indicating that it will be ignored or deferred without completing the usual process steps. - Standalone Mode > Projects [Complete the project](https://g6ehnyblk1.apidog.io/complete-the-project-17739062e0.md): Change the overall project status to “completed,” signaling that all required tasks, models, and approvals have been finalized. - Standalone Mode > Projects [Upload pdf for project model](https://g6ehnyblk1.apidog.io/upload-pdf-for-project-model-17739063e0.md): Upload a PDF document related to a specific project model. This can include design documents, reports, or specifications necessary for the model’s context. - Standalone Mode > Projects [Adding project model attribute](https://g6ehnyblk1.apidog.io/adding-project-model-attribute-17739064e0.md): Add new attribute(s) or property fields to a project model to expand its metadata, such as dimensions, materials, version info, or custom tags. - Standalone Mode > Projects [Get the project model component](https://g6ehnyblk1.apidog.io/get-the-project-model-component-17739065e0.md): Retrieve detailed information about components or sub-elements associated with a particular project model. Components can be parts, assemblies, or functional units. - Standalone Mode > Projects [Downloading pdf in project ](https://g6ehnyblk1.apidog.io/downloading-pdf-in-project-17739066e0.md): Download one or more PDF files that are linked to the project, such as reports, plans, or reference documents. - Standalone Mode > Projects [Upload image and get url](https://g6ehnyblk1.apidog.io/upload-image-and-get-url-17739067e0.md): Upload an image file related to a project or annotation, returning a publicly accessible URL or a storage path for use in the project or annotation context. - Standalone Mode > Projects [Get project settings](https://g6ehnyblk1.apidog.io/get-project-settings-17739068e0.md): Retrieve the configuration settings for a project, including preferences, notification settings, and workflow parameters. - Standalone Mode > Checklists [Creating the Checklist ](https://g6ehnyblk1.apidog.io/creating-the-checklist-17739069e0.md): 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. - Standalone Mode > Checklists [Get project checklist](https://g6ehnyblk1.apidog.io/get-project-checklist-17739070e0.md): Fetch the list of checklist items or tasks associated with a project, including their status and assignees. - Standalone Mode > Checklists [Create project checklist](https://g6ehnyblk1.apidog.io/create-project-checklist-17739071e0.md): Add new checklist items to a project to track tasks, requirements, or compliance points. - Standalone Mode > Checklists [Delete project checklist](https://g6ehnyblk1.apidog.io/delete-project-checklist-17739072e0.md): Remove specified checklist items from the project. - Standalone Mode > Checklists [Get All checklist by Project Id](https://g6ehnyblk1.apidog.io/get-all-checklist-by-project-id-17739073e0.md): Fetch all checklist items linked to a particular project by its ID. - Standalone Mode > Checklists [Update project checklist](https://g6ehnyblk1.apidog.io/update-project-checklist-17739074e0.md): Modify details of existing checklist items, such as status, description, or priority. - Standalone Mode > Checklists [Reset project checklist ](https://g6ehnyblk1.apidog.io/reset-project-checklist-17739075e0.md): Clear or reset the status of all checklist items for a project, often used to start the checklist process anew. - Standalone Mode > Checklists [Getting the relevant checklists](https://g6ehnyblk1.apidog.io/getting-the-relevant-checklists-17739076e0.md): Returns all checklists associated with a given model, user, or role context. These checklists are used for validation, QA, or workflow tracking, and vary depending on user permissions and model status. - Standalone Mode > Checklists [Fetching the predefined checklists](https://g6ehnyblk1.apidog.io/fetching-the-predefined-checklists-17739077e0.md): Retrieves a list of standardized checklists created in advance by admins or template designers. These can be reused across multiple models or projects for consistency and process enforcement. - Standalone Mode > Checklists [Creating the predefined checklist](https://g6ehnyblk1.apidog.io/creating-the-predefined-checklist-17739078e0.md): Allows users to create a new predefined checklist that can be assigned or reused across multiple projects or models. Each checklist includes tasks, validation steps, and optional metadata. - Standalone Mode > Checklists [Updating the predefined checklist ](https://g6ehnyblk1.apidog.io/updating-the-predefined-checklist-17739079e0.md): Updates an existing predefined checklist, including modifying its title, items, or metadata. This is useful for refining workflow standards or improving clarity of steps. - Standalone Mode > Checklists [Deleting the predefined checklist](https://g6ehnyblk1.apidog.io/deleting-the-predefined-checklist-17739080e0.md): Permanently deletes a predefined checklist from the system. This is used to clean up outdated or incorrect checklist templates. Deletion is irreversible. - Standalone Mode > Checklists [Creating the checklist by uploading a csv](https://g6ehnyblk1.apidog.io/creating-the-checklist-by-uploading-a-csv-17739081e0.md): Enables users to upload a CSV file to bulk create checklist items. Each row in the CSV is treated as a checklist entry, allowing fast onboarding of external task lists into the system. - Standalone Mode > Analytics & Reporting [Get project analytics](https://g6ehnyblk1.apidog.io/get-project-analytics-17739094e0.md): Retrieve summarized analytics and key metrics about the project’s progress, usage, and user activity. - Standalone Mode > Analytics & Reporting [Get project analytics data](https://g6ehnyblk1.apidog.io/get-project-analytics-data-17739095e0.md): Fetch detailed analytical data points or reports for deeper insights into project performance and trends. - Standalone Mode > Task Tracking [Get inspector availability ](https://g6ehnyblk1.apidog.io/get-inspector-availability-17739090e0.md): Retrieve availability schedules for inspectors assigned to the project. - Standalone Mode > Task Tracking [Create Inspector availability](https://g6ehnyblk1.apidog.io/create-inspector-availability-17739091e0.md): Add availability time slots for an inspector related to the project. - Standalone Mode > Task Tracking [Creating Bulk inspector availability ](https://g6ehnyblk1.apidog.io/creating-bulk-inspector-availability-17739092e0.md): Add multiple availability records at once for inspectors, useful for batch scheduling. - Standalone Mode > Task Tracking [Update Inspector availability ](https://g6ehnyblk1.apidog.io/update-inspector-availability-17739093e0.md): Modify existing inspector availability details. - Edge Mode > Models [Create the Model](https://g6ehnyblk1.apidog.io/create-the-model-17554704e0.md): 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. - Edge Mode > Models [Get All the models ](https://g6ehnyblk1.apidog.io/get-all-the-models-17551038e0.md): This API retrieves a complete list of all models available in the system. It is typically used to display or manage the existing models in the frontend interface. The response includes model metadata such as model ID, name, creation date, and status. - Edge Mode > Models [Getting the child models of a parent](https://g6ehnyblk1.apidog.io/getting-the-child-models-of-a-parent-17554711e0.md): This endpoint fetches all the child models linked to a specific parent model. It requires the parent model's ID as input and returns an array of child model objects. Useful in hierarchical or modular model structures where one model is composed of sub-models. - Edge Mode > Models [Fetching models based on user role ](https://g6ehnyblk1.apidog.io/fetching-models-based-on-user-role-17555348e0.md): - Edge Mode > Models [Clone model by root model Id](https://g6ehnyblk1.apidog.io/clone-model-by-root-model-id-17555366e0.md): This endpoint creates an exact copy of an existing model (the "root model") identified by its ID. The clone will include all associated metadata, structure, and attributes. Commonly used when building new models based on a previous template or configuration. - Edge Mode > Models [Generate Model through AI by Uploading Image for specific trained models](https://g6ehnyblk1.apidog.io/generate-model-through-ai-by-uploading-image-for-specific-trained-models-17555432e0.md): This advanced endpoint allows users to upload an image, which is then processed using an AI/ML model trained to recognize specific features. Based on the image content, a model is auto-generated with attributes inferred from the image. Ideal for applications like product digitization, object modeling, etc. - Edge Mode > Models [Fetching the model Attributes ](https://g6ehnyblk1.apidog.io/fetching-the-model-attributes-17555438e0.md): Fetches all the attributes or fields defined within a specific model. This includes each attribute’s name, type, default value (if any), and whether it is required or optional. Useful for displaying model structure or preparing forms dynamically. - Edge Mode > Models [Deleting the attributes ](https://g6ehnyblk1.apidog.io/deleting-the-attributes-17555439e0.md): Deletes one or more attributes from an existing model. This operation requires the model ID and the attribute(s) to be deleted. Use with caution as removing attributes may affect linked data or system behavior. - Edge Mode > Models [Fetching a particular model by Id](https://g6ehnyblk1.apidog.io/fetching-a-particular-model-by-id-17555457e0.md): Retrieves complete details of a specific model using its unique identifier. The response includes metadata, all attributes, and any linked configurations. Commonly used in model detail pages or edit interfaces. - Edge Mode > Models [Creating the Model Attributes](https://g6ehnyblk1.apidog.io/creating-the-model-attributes-17555464e0.md): Allows the user to define and add new attributes (fields) to a model. Each attribute includes properties like name, data type, validation rules, and default values. Useful for customizing models to suit specific use cases. - Edge Mode > Models [Deleting A Model By Id](https://g6ehnyblk1.apidog.io/deleting-a-model-by-id-17555465e0.md): Permanently deletes a model from the system using its ID. This action removes the model and all its associated attributes and data. Should be used only when the model is no longer needed, as this operation is irreversible. - Edge Mode > Models [Updating a Model by Id](https://g6ehnyblk1.apidog.io/updating-a-model-by-id-17555466e0.md): Updates the details of an existing model using its ID. This may include changes to the model name, description, or structure. Partial or full updates are supported depending on the implementation. - Edge Mode > Models [Creating the model Annotations](https://g6ehnyblk1.apidog.io/creating-the-model-annotations-17555885e0.md): Allows users to add annotations to a specific model. Annotations can include notes, comments, tags, or data insights that provide additional context or guidance related to the model’s content or structure. - Edge Mode > Models [Updating the model annotation](https://g6ehnyblk1.apidog.io/updating-the-model-annotation-17555903e0.md): Updates an existing annotation on a model. The update may include changes to the annotation text, metadata, or associated tags. Useful when correcting or expanding on earlier notes. - Edge Mode > Models [Deleting the Model annotation](https://g6ehnyblk1.apidog.io/deleting-the-model-annotation-17555910e0.md): Deletes a specific annotation from a model using its annotation ID. This is used to remove outdated, incorrect, or no longer needed notes from the model’s record. - Edge Mode > Models [fetching the model annotations](https://g6ehnyblk1.apidog.io/fetching-the-model-annotations-17555896e0.md): Retrieves all annotations that have been added to a given model. This is useful for review, collaboration, or audit purposes to understand the history and context of modifications or decisions. - Edge Mode > Models [Fetching the Model Components](https://g6ehnyblk1.apidog.io/fetching-the-model-components-17556051e0.md): Retrieves all components that are part of a given model. Components may include logical or physical units that make up the model's structure. Useful for understanding model decomposition and modular analysis. - Edge Mode > Models [Saving completion status for models ](https://g6ehnyblk1.apidog.io/saving-completion-status-for-models-17558153e0.md): Save or update the current progress or completion percentage/status of one or multiple models under a project to track workflow stages. - Edge Mode > Projects [Fetching the project model components ](https://g6ehnyblk1.apidog.io/fetching-the-project-model-components-17556789e0.md): Retrieves components associated with a specific project model. These may include structural units, modules, or parts tied to a larger project context. - Edge Mode > Projects [Get the recent projects](https://g6ehnyblk1.apidog.io/get-the-recent-projects-17556814e0.md): Returns a list of the most recently accessed or created projects by the user. Helps users quickly resume work or monitor latest project activity. - Edge Mode > Projects [Get the completed projects](https://g6ehnyblk1.apidog.io/get-the-completed-projects-17556815e0.md): Fetches all projects marked as completed or closed. This endpoint is useful for historical analysis, reporting, or archiving. - Edge Mode > Projects [Get the shared project](https://g6ehnyblk1.apidog.io/get-the-shared-project-17556819e0.md): Retrieves all projects that have been explicitly shared with the current user by others. Shared projects may include view or edit access depending on permissions. - Edge Mode > Projects [Fetching the projects](https://g6ehnyblk1.apidog.io/fetching-the-projects-17557755e0.md): Returns a comprehensive list of all projects accessible to the current user. Each project object includes details like ID, name, status, and creation date. - Edge Mode > Projects [Creating the project](https://g6ehnyblk1.apidog.io/creating-the-project-17557762e0.md): Allows users to create a new project by providing basic metadata such as project name, description, owner, and optionally a template or team assignment. - Edge Mode > Projects [Fetching the project by project Id](https://g6ehnyblk1.apidog.io/fetching-the-project-by-project-id-17557775e0.md): Retrieve comprehensive details about a specific project by providing its unique project ID. This includes metadata such as project name, description, status, associated users, and timestamps. - Edge Mode > Projects [Deleting the project by projectId](https://g6ehnyblk1.apidog.io/deleting-the-project-by-projectid-17557782e0.md): Permanently remove a project from the system by specifying its project ID. This action deletes all associated data including models, annotations, and documents linked to the project. - Edge Mode > Projects [Updating the project by Id](https://g6ehnyblk1.apidog.io/updating-the-project-by-id-17557785e0.md): Modify one or more attributes of an existing project identified by its ID. This could include changing the project name, description, deadline, status, or assigned team members. - Edge Mode > Projects [Get project model](https://g6ehnyblk1.apidog.io/get-project-model-17558166e0.md): Fetch detailed information about a particular model within a project, including its attributes, current status, linked documents, and associated components. - Edge Mode > Projects [create project model](https://g6ehnyblk1.apidog.io/create-project-model-17558233e0.md): Add a new model to a project, initializing its details and linking it to the parent project for tracking and management. - Edge Mode > Projects [Get project Model](https://g6ehnyblk1.apidog.io/get-project-model-17558234e0.md): Fetch detailed information about a particular model within a project, including its attributes, current status, linked documents, and associated components. - Edge Mode > Projects [Delete Project Model](https://g6ehnyblk1.apidog.io/delete-project-model-17558235e0.md): Remove a specified model and all related data such as components and attributes from the project permanently. - Edge Mode > Projects [Update the project model](https://g6ehnyblk1.apidog.io/update-the-project-model-17558236e0.md): Update various properties or metadata of an existing project model, such as model name, description, parameters, or status. - Edge Mode > Projects [Skip the project model](https://g6ehnyblk1.apidog.io/skip-the-project-model-17558241e0.md): Mark a project model as skipped in the workflow, indicating that it will be ignored or deferred without completing the usual process steps. - Edge Mode > Projects [Complete the project](https://g6ehnyblk1.apidog.io/complete-the-project-17558242e0.md): Change the overall project status to “completed,” signaling that all required tasks, models, and approvals have been finalized. - Edge Mode > Projects [Upload pdf for project model](https://g6ehnyblk1.apidog.io/upload-pdf-for-project-model-17559581e0.md): Upload a PDF document related to a specific project model. This can include design documents, reports, or specifications necessary for the model’s context. - Edge Mode > Projects [Adding project model attribute](https://g6ehnyblk1.apidog.io/adding-project-model-attribute-17560301e0.md): Add new attribute(s) or property fields to a project model to expand its metadata, such as dimensions, materials, version info, or custom tags. - Edge Mode > Projects [Get the project model component](https://g6ehnyblk1.apidog.io/get-the-project-model-component-17560358e0.md): Retrieve detailed information about components or sub-elements associated with a particular project model. Components can be parts, assemblies, or functional units. - Edge Mode > Projects [Downloading pdf in project ](https://g6ehnyblk1.apidog.io/downloading-pdf-in-project-17560523e0.md): Download one or more PDF files that are linked to the project, such as reports, plans, or reference documents. - Edge Mode > Projects [Upload image and get url](https://g6ehnyblk1.apidog.io/upload-image-and-get-url-17560534e0.md): Upload an image file related to a project or annotation, returning a publicly accessible URL or a storage path for use in the project or annotation context. - Edge Mode > Projects [Get project settings](https://g6ehnyblk1.apidog.io/get-project-settings-17560642e0.md): Retrieve the configuration settings for a project, including preferences, notification settings, and workflow parameters. - Edge Mode > Icon [Creating the Icon](https://g6ehnyblk1.apidog.io/creating-the-icon-17644152e0.md): Creates a new icon entry in the system by saving its metadata and linking it to a relevant entity (like a model, component, or checklist). This icon could be used for visual labeling, annotations, or UI elements. The API typically requires the icon name, description, and an image file or reference. - Edge Mode > Icon [Deleting the icon](https://g6ehnyblk1.apidog.io/deleting-the-icon-17644180e0.md): Removes a specific icon from the system using its unique identifier. This operation is irreversible and ensures the icon is no longer available for use in annotations, visual tags, or checklists. Often used during cleanup or redesign. - Edge Mode > Icon [Get the Icons](https://g6ehnyblk1.apidog.io/get-the-icons-17644184e0.md): Retrieves a list of icons available in the system, usually filtered by a specific project, category, or user. This allows frontends or tools to display selectable icons in dropdowns or icon pickers. - Edge Mode > Icon [Updating the Icon](https://g6ehnyblk1.apidog.io/updating-the-icon-17644200e0.md): Modifies the properties of an existing icon. This may include updating the icon name, category, description, or even replacing the associated image. Used when correcting or improving previously uploaded icons. - Edge Mode > Icon [Fetch all icons](https://g6ehnyblk1.apidog.io/fetch-all-icons-17644213e0.md): - Edge Mode > Icon [Uplaod an Icon](https://g6ehnyblk1.apidog.io/uplaod-an-icon-17644233e0.md): Handles the actual image upload process for an icon. This typically includes uploading a `.png`, `.svg`, or `.jpg` file, validating the format/size, and storing it in a media server or cloud storage. On success, it returns the file URL or path that can be linked to an icon entry. - Edge Mode > Templates [Get template](https://g6ehnyblk1.apidog.io/get-template-17644247e0.md): - Edge Mode > Templates [Create the Template](https://g6ehnyblk1.apidog.io/create-the-template-17644308e0.md): Creates a new template by specifying a name, category, structure, and possibly assigning it to a project or user. Templates act as blueprints for collecting or organizing information. - Edge Mode > Templates [Get template attributes](https://g6ehnyblk1.apidog.io/get-template-attributes-17644311e0.md): Fetches all the attributes (fields) associated with a specific template. These attributes define the fields users must fill when using the template (e.g., text fields, dropdowns, checkboxes). - Edge Mode > Templates [Create Template attribute](https://g6ehnyblk1.apidog.io/create-template-attribute-17644320e0.md): Adds a new attribute (field) to an existing template. For example, you might add a "Remarks" field or "Inspection Status" dropdown to a checklist template. - Edge Mode > Templates [Delete template attribute](https://g6ehnyblk1.apidog.io/delete-template-attribute-17644323e0.md): Removes a specific attribute from a template. This is used when a field is no longer needed in the data structure of that template. - Edge Mode > Templates [Update template attribute](https://g6ehnyblk1.apidog.io/update-template-attribute-17644443e0.md): Edits the properties of an existing template attribute. For instance, you might rename a field, change its data type, or modify its validation rules. - Edge Mode > Templates [Get template](https://g6ehnyblk1.apidog.io/get-template-17644444e0.md): Retrieves a list of all templates in the system or a specific set based on filters (like project, user, or type). Templates define structured formats used for annotations, inspections, documents, etc. Used to fetch a particular template by ID, including all its metadata, attributes, and configuration. - Edge Mode > Templates [Delete a Template](https://g6ehnyblk1.apidog.io/delete-a-template-17644446e0.md): Permanently removes a template from the system. This is typically restricted to admin users to prevent accidental loss of form structures and historical data. - Edge Mode > Templates [Update a template](https://g6ehnyblk1.apidog.io/update-a-template-17644469e0.md): Updates core details of an existing template, such as its name, purpose, visibility, or assigned project. It doesn’t affect the attributes unless explicitly included. - Edge Mode > Templates [Create template header](https://g6ehnyblk1.apidog.io/create-template-header-17644520e0.md): Adds a header section to a template — used to organize or label a group of attributes under a titled section, improving clarity and layout (like “General Info” or “Inspection Details”). - Edge Mode > Templates [Get all template headers](https://g6ehnyblk1.apidog.io/get-all-template-headers-17645433e0.md): Retrieves all headers created for a specific template. This helps display template sections in order and associate attributes correctly under each header. - Edge Mode > Templates [Update the template header ](https://g6ehnyblk1.apidog.io/update-the-template-header-17645454e0.md): Modifies the label or order of a template header. Useful when reorganizing how fields are grouped or shown to users during data entry. - Edge Mode > Templates [Delete template header](https://g6ehnyblk1.apidog.io/delete-template-header-17645541e0.md): Removes a specific header from the template. Attributes under this header may either be deleted or re-assigned to another header, depending on the system’s design. - Edge Mode > Checklists [Creating the Checklist ](https://g6ehnyblk1.apidog.io/creating-the-checklist-17555484e0.md): 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. - Edge Mode > Checklists [Get project checklist](https://g6ehnyblk1.apidog.io/get-project-checklist-17560649e0.md): Fetch the list of checklist items or tasks associated with a project, including their status and assignees. - Edge Mode > Checklists [Create project checklist](https://g6ehnyblk1.apidog.io/create-project-checklist-17560696e0.md): Add new checklist items to a project to track tasks, requirements, or compliance points. - Edge Mode > Checklists [Delete project checklist](https://g6ehnyblk1.apidog.io/delete-project-checklist-17560703e0.md): Remove specified checklist items from the project. - Edge Mode > Checklists [Get All checklist by Project Id](https://g6ehnyblk1.apidog.io/get-all-checklist-by-project-id-17560879e0.md): Fetch all checklist items linked to a particular project by its ID. - Edge Mode > Checklists [Update project checklist](https://g6ehnyblk1.apidog.io/update-project-checklist-17560718e0.md): Modify details of existing checklist items, such as status, description, or priority. - Edge Mode > Checklists [Reset project checklist ](https://g6ehnyblk1.apidog.io/reset-project-checklist-17560882e0.md): Clear or reset the status of all checklist items for a project, often used to start the checklist process anew. - Edge Mode > Checklists [Getting the relevant checklists](https://g6ehnyblk1.apidog.io/getting-the-relevant-checklists-17556053e0.md): Returns all checklists associated with a given model, user, or role context. These checklists are used for validation, QA, or workflow tracking, and vary depending on user permissions and model status. - Edge Mode > Checklists [Fetching the predefined checklists](https://g6ehnyblk1.apidog.io/fetching-the-predefined-checklists-17556067e0.md): Retrieves a list of standardized checklists created in advance by admins or template designers. These can be reused across multiple models or projects for consistency and process enforcement. - Edge Mode > Checklists [Creating the predefined checklist](https://g6ehnyblk1.apidog.io/creating-the-predefined-checklist-17556245e0.md): Allows users to create a new predefined checklist that can be assigned or reused across multiple projects or models. Each checklist includes tasks, validation steps, and optional metadata. - Edge Mode > Checklists [Updating the predefined checklist ](https://g6ehnyblk1.apidog.io/updating-the-predefined-checklist-17556258e0.md): Updates an existing predefined checklist, including modifying its title, items, or metadata. This is useful for refining workflow standards or improving clarity of steps. - Edge Mode > Checklists [Deleting the predefined checklist](https://g6ehnyblk1.apidog.io/deleting-the-predefined-checklist-17556260e0.md): Permanently deletes a predefined checklist from the system. This is used to clean up outdated or incorrect checklist templates. Deletion is irreversible. - Edge Mode > Checklists [Creating the checklist by uploading a csv](https://g6ehnyblk1.apidog.io/creating-the-checklist-by-uploading-a-csv-17556765e0.md): Enables users to upload a CSV file to bulk create checklist items. Each row in the CSV is treated as a checklist entry, allowing fast onboarding of external task lists into the system. - Edge Mode > Annotations [get the annotaion ](https://g6ehnyblk1.apidog.io/get-the-annotaion-17560366e0.md): Fetch a list of all annotations linked to a project or its models. Annotations could be comments, markings, or highlights made on documents or models. - Edge Mode > Annotations [get annotation by Id](https://g6ehnyblk1.apidog.io/get-annotation-by-id-17560376e0.md): Retrieve the details of a specific annotation using its unique identifier, including the annotation content, author, timestamp, and linked document or page. - Edge Mode > Annotations [Create the annotation](https://g6ehnyblk1.apidog.io/create-the-annotation-17560413e0.md): Add a new annotation to a project or model, such as notes, comments, or graphical markings on a document or model visualization. - Edge Mode > Annotations [Saving annotation in canvas](https://g6ehnyblk1.apidog.io/saving-annotation-in-canvas-17560420e0.md): Persist the current state of an annotation drawn or edited on an interactive canvas or graphical interface, ensuring changes are saved. - Edge Mode > Annotations [Updating the Annotation](https://g6ehnyblk1.apidog.io/updating-the-annotation-17560514e0.md): Modify existing annotation details such as content, position, color, or related metadata. - Edge Mode > Annotations [Delete annotation by page number](https://g6ehnyblk1.apidog.io/delete-annotation-by-page-number-17560519e0.md): Remove all annotations associated with a specific page number in a document, often used when clearing or resetting annotations for a particular section. - Edge Mode > Annotations [Delete annotation ](https://g6ehnyblk1.apidog.io/delete-annotation-17560522e0.md): Permanently delete a specific annotation by its ID from the system. - Edge Mode > Annotations [Get annotations with component](https://g6ehnyblk1.apidog.io/get-annotations-with-component-17556060e0.md): Fetches annotations linked to specific components within a model. Each annotation provides additional metadata, comments, or insights about that component, aiding collaborative review and analysis. - Edge Mode > Analytics & Reporting [Get project analytics](https://g6ehnyblk1.apidog.io/get-project-analytics-17560640e0.md): Retrieve summarized analytics and key metrics about the project’s progress, usage, and user activity. - Edge Mode > Analytics & Reporting [Get project analytics data](https://g6ehnyblk1.apidog.io/get-project-analytics-data-17560641e0.md): Fetch detailed analytical data points or reports for deeper insights into project performance and trends. - Edge Mode > Project Management Tool [Get project access ](https://g6ehnyblk1.apidog.io/get-project-access-17560541e0.md): Retrieve the current access control list or permissions set for a project, detailing which users or roles have which levels of access. - Edge Mode > Project Management Tool [Update project access ](https://g6ehnyblk1.apidog.io/update-project-access-17560593e0.md): Modify access permissions for users or roles on the project, enabling management of who can view, edit, or administer the project. - Edge Mode > Project Management Tool [Get the project model access](https://g6ehnyblk1.apidog.io/get-the-project-model-access-17557787e0.md): Retrieve the list of users or roles who have access permissions to the project’s model(s), including their specific access levels such as read, write, or admin. - Edge Mode > Project Management Tool [Updating the project model access](https://g6ehnyblk1.apidog.io/updating-the-project-model-access-17557801e0.md): Change or update access rights for users on the project model. This allows granting or revoking permissions such as editing, viewing, or managing the model. - Edge Mode > Project Management Tool [Delete project access](https://g6ehnyblk1.apidog.io/delete-project-access-17560596e0.md): Revoke or remove access permissions for specified users or roles on the project. - Edge Mode > Project Management Tool [Get project invitation](https://g6ehnyblk1.apidog.io/get-project-invitation-17560606e0.md): Retrieve details of pending or sent project invitations, including invitee information, invitation status, and expiry. - Edge Mode > Project Management Tool [send project invitation](https://g6ehnyblk1.apidog.io/send-project-invitation-17560611e0.md): Send an invitation to a user to join or collaborate on a project, specifying their role and access level. - Edge Mode > Project Management Tool [Validate project invitation](https://g6ehnyblk1.apidog.io/validate-project-invitation-17560623e0.md): Verify the validity and status of a project invitation, ensuring the invite is active and can be accepted. - Edge Mode > Project Management Tool [Project Invitation Accept](https://g6ehnyblk1.apidog.io/project-invitation-accept-17560625e0.md): Endpoint for the invited user to accept the project invitation, granting them access as specified. - Edge Mode > Project Management Tool [Cancel Project Invitation](https://g6ehnyblk1.apidog.io/cancel-project-invitation-17560637e0.md): Cancel or withdraw a previously sent project invitation before it is accepted. - Edge Mode > Task Tracking [Get inspector availability ](https://g6ehnyblk1.apidog.io/get-inspector-availability-17560727e0.md): Retrieve availability schedules for inspectors assigned to the project. - Edge Mode > Task Tracking [Create Inspector availability](https://g6ehnyblk1.apidog.io/create-inspector-availability-17560744e0.md): Add availability time slots for an inspector related to the project. - Edge Mode > Task Tracking [Creating Bulk inspector availability ](https://g6ehnyblk1.apidog.io/creating-bulk-inspector-availability-17560870e0.md): Add multiple availability records at once for inspectors, useful for batch scheduling. - Edge Mode > Task Tracking [Update Inspector availability ](https://g6ehnyblk1.apidog.io/update-inspector-availability-17560872e0.md): Modify existing inspector availability details. - Edge Mode > Estimations And Analytics [Fetching the project estimations](https://g6ehnyblk1.apidog.io/fetching-the-project-estimations-17556796e0.md): - Edge Mode > Estimations And Analytics [Creating the project estimations](https://g6ehnyblk1.apidog.io/creating-the-project-estimations-17556802e0.md): Creates new estimation entries for a project. This may include defining resources, timelines, and budgets needed for completion. Can be used during the planning or bidding phase. - Edge Mode > Estimations And Analytics [Fetching the project estimations analytics](https://g6ehnyblk1.apidog.io/fetching-the-project-estimations-analytics-17556805e0.md): Provides analytical insights based on the project's estimation data. This includes metrics like cost variance, estimation vs. actual analysis, or estimation trends. - Edge Mode > Estimations And Analytics [Download the project estimation analytics ](https://g6ehnyblk1.apidog.io/download-the-project-estimation-analytics-17556807e0.md): Generates and downloads an analytical report of the project’s estimations. This may include charts, metrics, and summaries in PDF or CSV format for stakeholder reporting. - Edge Mode > Estimations And Analytics [Updating the project estimations](https://g6ehnyblk1.apidog.io/updating-the-project-estimations-17556811e0.md): - Edge Mode > Estimations And Analytics [Deleting the project estimation by Id](https://g6ehnyblk1.apidog.io/deleting-the-project-estimation-by-id-17556812e0.md): Deletes a specific estimation entry using its unique identifier. This may be used to remove incorrect or outdated estimation records.