My Project
  1. Edge Mode
My Project
  • Api Documentation
  • Standalone Mode
    • 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
    • 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
      • 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. Edge Mode

Edge Mode

Edge Mode
Screenshot 2025-06-19 134020.png

Project Management Tool#

• Get project model access: Retrieves a list of users and their access levels to a specific project model. Useful for displaying who has permission to view, edit, or manage a model.
• Updating the project model access: Updates the access levels (read/write/admin) of users or roles for a specific project model. Enables finer control over who can perform what actions.
• Get project access: Returns access configuration for a user on a project, indicating whether they can view, edit, or manage the overall project.
• Update project access: Changes the access rights of a specific user or role on a project, allowing updates such as promoting a user to project manager.
• Delete project access: Revokes access permissions from a user, effectively removing them from the project.
• Get project invitation: Retrieves the status of invitations sent to users for project collaboration, including pending, accepted, or expired statuses.
• Send project invitation: Sends an invitation to a user to join a project, typically via email, including their assigned role or access level.
• Validate project invitation: Verifies whether a project invitation is valid, active, and associated with a legitimate user or email.
• Project Invitation Accept: Accepts a received project invitation and grants the user access to the project as defined in the invitation.
• Cancel Project Invitation: Cancels a previously sent invitation, preventing the recipient from joining the project.

Templates#

• Get Template: Retrieves a list of templates used for annotations, checklists, or other structured input forms, often filtered by type or project.
• Create the Template: Creates a new template structure with a name and category, used to standardize data collection or document formatting.
• Get template attributes: Retrieves the individual fields or input components defined within a template (e.g., text field, dropdown, checkbox).
• Create Template attribute: Adds a new field or attribute to a template, helping to capture more detailed information or customize the form.
• Delete template attribute: Removes an existing attribute or field from a template, used when a field is no longer needed.
• Update template attribute: Modifies the properties of an existing field, such as name, type, or options (for dropdowns).
• Delete a Template: Removes the entire template from the system, including all its fields and references.
• Update a template: Edits template-level metadata, such as its name, category, or associated project type.
• Create template header: Adds a visual or logical section header to group template attributes, improving organization and readability.
• Get all template headers: Lists all section headers currently created in a template, along with their order
• Update the template header: Modifies the title or order of an existing header section.
• Delete template header: Removes a section header from a template, optionally reassigning or deleting its child attributes

Icons#

• Creating the Icon: Adds a new icon to the system, which may be used in annotations, labels, or UI components for visual identification.
• Deleting the icon: Permanently removes an icon image and its metadata from the system.
• Get the Icons: Retrieves a filtered list of icons based on project, user, or use-case to populate selection lists in UI.
• Updating the Icons: Edits the metadata of an icon, such as its name, tags, or replacement image.
• Fetch all Icons: Retrieves the entire icon library available to the system, regardless of project or user scope.
• Upload an Icon: Uploads an image file (typically SVG, PNG, or JPG) to the system to be used as a custom icon.
Modified at 2025-06-19 16:33:44
Previous
Update Inspector availability
Next
Models
Built with