Download OpenAPI specification:Download
This page contains the documentation on how to use the Vuforia Model Target Web API.
Start the creation of an advanced Model Target dataset.
Advanced datasets can have one or more models
each with one or more views
.
name required | string (Name) [ 1 .. 127 ] characters ^[a-zA-Z0-9 _-]+$ Dataset name |
required | Array of objects (CadModelAdvanced) [ 1 .. 20 ] items An advanced Model Target dataset can be used to recognize and track one or more models, each from one or more views. When using targetSdk >= 10.5, a maximum of 20 models and 300 views per model is allowed. When using targetSdk < 10.5, a maximum of 20 views across all models is allowed, that is, if all models have one view, a maximum of 20 models is allowed. |
targetSdk required | string The minimum Vuforia Engine SDK version (in "X.Y" format, such as "10.3") that will be used to load the generated dataset. |
preserveCadModel | boolean Default: false Allow PTC Vuforia to preserve the CAD Models and associated data for troubleshooting purposes. |
realisticAppearance | boolean Deprecated Deprecated since Training will make use of the CAD model's textures.
|
{- "name": "string",
- "models": [
- {
- "name": "string",
- "cadDataBlob": "string",
- "cadDataUrl": "string",
- "cadDataFormat": "ZIP",
- "views": [
- {
- "name": "string",
- "guideViewPosition": {
- "rotation": [
- 0,
- 0,
- 0,
- 0
], - "translation": [
- 0,
- 0,
- 0
]
}, - "layout": "portrait",
- "recognitionRanges": {
- "azimRange": [
- 0,
- 0
], - "distRange": [
- 0,
- 0
], - "elevRange": [
- 0,
- 0
], - "rollRange": [
- 0,
- 0
], - "rotation": [
- 0,
- 0,
- 0,
- 0
]
}, - "recognitionRangesPreset": "DOME",
- "userVolume": {
- "volume": {
- "rotation": [
- 0,
- 0,
- 0,
- 0
], - "scale": [
- 0,
- 0,
- 0
], - "translation": [
- 0,
- 0,
- 0
]
}, - "minDistanceFromTarget": 0,
- "representativePosition": [
- 0,
- 0,
- 0
]
}, - "partReference": {
- "partName": "string",
- "partIdPath": "string",
- "occurrenceId": "string"
}, - "targetExtent": {
- "rotation": [
- 0,
- 0,
- 0,
- 0
], - "scale": [
- 0,
- 0,
- 0
], - "translation": [
- 0,
- 0,
- 0
]
}, - "targetExtentPreset": "FULL_MODEL",
- "states": [
- "string"
]
}
], - "motionHint": "static",
- "simplificationParameters": {
- "polygonCount": 400000
}, - "simplify": "auto",
- "trackingMode": "default",
- "optimizeTrackingFor": "default",
- "automaticColoring": "always",
- "upVector": [
- 0,
- 0,
- 0
], - "uniformScale": 1,
- "realisticAppearance": "true",
- "stateBasedConfigurationJsonString": "None"
}
], - "targetSdk": "string",
- "preserveCadModel": false,
- "realisticAppearance": true
}
{- "uuid": "0b12466eee5d49409a440927006ff5d8"
}
If creation is in progress, the operation is canceled and the dataset and its associated data is deleted.
uuid required | string |
{- "error": {
- "code": "401",
- "message": "no Bearer token",
- "target": "jwt"
}
}
The status of the training can be "done", "processing" or "failed". More details regarding the possible errors can be seen on the left hand side in the "Examples" dropdown.
The "innerError / error_conditions "
field is deprecated.
uuid required | string |
{- "status": "done",
- "uuid": "0b12466eee5d49409a440927006ff5d8",
- "createdAt": "2023-11-22T13:30:35.578Z"
}
Start the creation of a standard Model Target dataset.
A standard Model Target must have exactly one models
with one or more views
.
The views
only need to specify the guideViewPosition
, not the targetExtent
or the recognitionRanges
.
name required | string (Name) [ 1 .. 127 ] characters ^[a-zA-Z0-9 _-]+$ Dataset name |
required | Array of objects (CadModelStandard) = 1 items A standard Model Target dataset can be used to recognize and track one model from one or more views. The model array must contain exactly one model. |
targetSdk required | string The minimum Vuforia Engine SDK version (in "X.Y" format, such as "10.3") that will be used to load the generated dataset. |
preserveCadModel | boolean Default: false Allow PTC Vuforia to preserve the CAD models and associated data for troubleshooting purposes. |
{- "name": "string",
- "models": [
- {
- "name": "string",
- "cadDataBlob": "string",
- "cadDataUrl": "string",
- "cadDataFormat": "ZIP",
- "views": [
- {
- "name": "string",
- "guideViewPosition": {
- "rotation": [
- 0,
- 0,
- 0,
- 0
], - "translation": [
- 0,
- 0,
- 0
]
}, - "layout": "portrait"
}
], - "motionHint": "static",
- "simplificationParameters": {
- "polygonCount": 400000
}, - "simplify": "auto",
- "trackingMode": "default",
- "optimizeTrackingFor": "default",
- "automaticColoring": "always",
- "upVector": [
- 0,
- 0,
- 0
], - "uniformScale": 1,
- "stateBasedConfigurationJsonString": "None"
}
], - "targetSdk": "string",
- "preserveCadModel": false
}
{- "uuid": "0b12466eee5d49409a440927006ff5d8"
}
If creation is in progress, the operation is canceled and the dataset and its associated data is deleted.
uuid required | string |
{- "error": {
- "code": "401",
- "message": "no Bearer token",
- "target": "jwt"
}
}
Status can be "done", "processing" or "failed".
uuid required | string |
{- "status": "done",
- "uuid": "0b12466eee5d49409a440927006ff5d8",
- "createdAt": "2023-11-22T13:30:35.578Z"
}