Create the annotation

Developing

POST

/project/{projectId}/model/{projectModelId}/annotation/new

Add a new annotation to a project or model, such as notes, comments, or graphical markings on a document or model visualization.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/project//model//annotation/new' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pickModelComponentId": "pickComp123",
    "pageNumber": 1,
    "annotationData": {
        "id": "annotation-uuid-optional",
        "notes": "This is a test annotation",
        "boundingBox": {
            "x": 100,
            "y": 200,
            "width": 150,
            "height": 120
        },
        "tags": [
            "important",
            "issue"
        ]
    }
}'

Response Example

{}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

projectId

string

required

projectModelId

string

required

Body Params application/json

object {0}

Examples

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2025-06-06 14:57:08

get annotation by Id

Saving annotation in canvas