Creating the model Annotations

Developing

POST

/model/{modelId}/component

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/model//component' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "object",
    "required": [
        "name"
    ],
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the component",
            "example": "Engine Compartment"
        },
        "iconName": {
            "type": "string",
            "description": "Optional icon name for the component",
            "example": "engine_icon"
        },
        "imageUrl": {
            "type": "string",
            "description": "URL of the image representing the component",
            "example": "https://cdn.example.com/images/engine.png"
        },
        "parent": {
            "type": "boolean",
            "description": "Flag indicating whether to associate the parent model (if applicable)",
            "example": true
        }
    },
    "example": {
        "name": "Engine Compartment",
        "iconName": "engine_icon",
        "imageUrl": "https://cdn.example.com/images/engine.png",
        "parent": true
    }
}'

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 16:19:15

Updating a Model by Id

Updating the model annotation