Model Target Web API (latest)

Download OpenAPI specification:Download

License: PTC Commercial

This page contains the documentation on how to use the Vuforia Model Target Web API.

Advanced Datasets

Create and manage advanced Model Target Datasets

Create an advanced Model Target dataset

Start the creation of an advanced Model Target dataset.

Advanced datasets can have one or more models each with one or more views.

Authorizations:
oAuth2ClientCredentials
Request Body schema: application/json
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 targetSdk == 10.9. For targetSdk >= 10.9 the realisticAppearance flag that is defined at CadModel level must be used.

Training will make use of the CAD model's textures.

realisticAppearance cannot be true when automaticColoring is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "models": [
    ],
  • "targetSdk": "string",
  • "preserveCadModel": false,
  • "realisticAppearance": true
}

Response samples

Content type
application/json
{
  • "uuid": "0b12466eee5d49409a440927006ff5d8"
}

Delete the dataset

If creation is in progress, the operation is canceled and the dataset and its associated data is deleted.

Authorizations:
oAuth2ClientCredentials
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Download the Model Target dataset.

Authorizations:
oAuth2ClientCredentials
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get the dataset creation status.

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.

Authorizations:
oAuth2ClientCredentials
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "status": "done",
  • "uuid": "0b12466eee5d49409a440927006ff5d8",
  • "createdAt": "2023-11-22T13:30:35.578Z"
}

Datasets

Create and manage standard Model Target Datasets

Create a standard Model Target dataset.

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.

Authorizations:
oAuth2ClientCredentials
Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "models": [
    ],
  • "targetSdk": "string",
  • "preserveCadModel": false
}

Response samples

Content type
application/json
{
  • "uuid": "0b12466eee5d49409a440927006ff5d8"
}

Delete the dataset

If creation is in progress, the operation is canceled and the dataset and its associated data is deleted.

Authorizations:
oAuth2ClientCredentials
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Download the Model Target dataset.

Authorizations:
oAuth2ClientCredentials
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get the dataset creation status.

Status can be "done", "processing" or "failed".

Authorizations:
oAuth2ClientCredentials
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "done",
  • "uuid": "0b12466eee5d49409a440927006ff5d8",
  • "createdAt": "2023-11-22T13:30:35.578Z"
}