Initiate Model Comparison Task (Spot-the-Difference)

POST

/openapi/v2.0/model/api/v1/workspaces/{workspace_id}/comparators

Initiate a "spot-the-difference" AI detection task based on two 3D models (reference model + comparison model); identifies changes between two modelings (e.g. added / disappeared objects). Tasks execute asynchronously; results polled via list / detail APIs.

Request

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "name": "example_name",
    "old_task_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "origin_file_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "refer_file_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "exclude_diff_types": [
        1
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/openapi/v2.0/model/api/v1/workspaces//comparators' \
--header 'x-user-token;' \
--header 'x-user-token;' \
--header 'X-Request-Id: 5dff27bd-693c-4ace-979d-e26e920d497a' \
--header 'X-Request-Id;' \
--header 'X-Project-Uuid;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "example_name",
    "old_task_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "origin_file_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "refer_file_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "exclude_diff_types": [
        1
    ]
}'

Responses

🟢200

application/json

success

Bodyapplication/json

Example

{
    "code": 0,
    "message": "OK",
    "data": {
        "uuid": "compare-task-001-uuid"
    }
}

🟠400

🟠401

🟠403

🟠404

🔴500

Modified at 2026-06-15 13:36:31

Get Change Area Details in Result Group

Query Model Comparison Task List