Skip to content

[WIP] Create Annotation Request

POSThttps://${domain}/rosetta-open/annotation-request

Guidelines for creating an annotation request on Rosetta.

WARNING

The 'taxonomyInfo' field is not used in the current version.

body params

*annotationRequestIdstring Defaults to 7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b
Unique identifier for the annotation request, with a maximum length of 160 bytes.
*annotationRequestNamestring Defaults to Helix 3D Annotation Request
Name of the annotation request, must be unique with a maximum length of 160 bytes.
*campaignIdstring Defaults to 7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b
Unique identifier for the associated campaign.
*sceneIdMapMap Defaults to { "550e8400-e29b-41d4-a716-446655440000": "gs://marry-me-scene/test/A.yaml", "f47ac10b-58cc-4372-a567-0e02b2c3d479": "gs://marry-me-scene/test/B.json" }
Mapping of scene IDs relevant to the annotation request.
taxonomyInfostring
Additional information about the Helix taxonomy.
annotationRequestCallbackstring
Callback URL for receiving updates on annotation request status.
annotationResultCallbackMap
Mapping of callback URLs for annotation result notifications.
Examples
shell
curl https://${domain}/rosetta-open/annotation-request \
 -X POST \
 -H 'Content-Type: application/json' \
 -H 'X-STARDUST-KEY: <X-STARDUST-KEY>' \
 -H 'X-TS: <X-TS>' \
 -H 'X-SIGN: <X-SIGN>' \
 -d '{"annotationRequestId":"7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b","annotationRequestName":"Helix 3D Annotation Request","campaignId":"7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b","sceneIdMap":{"550e8400-e29b-41d4-a716-446655440000":"gs://marry-me-scene/test/A.yaml","f47ac10b-58cc-4372-a567-0e02b2c3d479":"gs://marry-me-scene/test/B.json"}}'

responses

2000
{
"code": 2000,
"message": "Success",
"data": null,
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": true
}
5000
{
"code": 5000,
"data": null,
"message": "Service hiccuped, please try again later.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}
51008
{
"code": 51008,
"data": null,
"message": "Campaign not exists.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}
52001
{
"code": 52001,
"data": null,
"message": "Create workflow failed.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}
52002
{
"code": 52002,
"data": null,
"message": "Workflow pool is empty.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}
53001
{
"code": 53001,
"data": null,
"message": "Do not create annotation request repeatedly.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}
53004
{
"code": 53004,
"data": null,
"message": "annotationRequestId is already exists.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}
53005
{
"code": 53005,
"data": null,
"message": "annotationRequestName is already exists.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}