Table of contents
Reality Analysis
Download API definition:
This API is a Technical Preview and is available for testing purposes only. Do not use in production.
POST https://dev-api.bentley.com/reality-analysis/detectors/{detectorName}/versions

Create a new detector version.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request parameters

Name
Required?
Description
detectorName
Yes

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Request body

Detector version create payload

Name
Type
Required?
Description
versionNumber
String
Yes

Version number of the detector.

capabilities
Yes

Capabilities of the version.

Example

json
{
    "versionNumber": "2.0",
    "capabilities": {
        "labels": [
            "signs"
        ],
        "exports": [
            "Objects"
        ]
    }
}

Response 201 Created

This response indicates that the detector version was successfully created.

json
{
    "version": {
        "creationDate": "2025-08-08T08:06:30.2466033Z",
        "versionNumber": "1.0",
        "status": "AwaitingData",
        "creatorId": "4f2d47ac-e318-46dc-ae53-06d71c9ff79e",
        "capabilities": {
            "labels": [
                "signs"
            ],
            "exports": [
                "Objects"
            ]
        }
    },
    "_links": {
        "completeUrl": {
            "href": "detectors/traffic-signs/version/1.0/complete"
        },
        "uploadUrl": {
            "href": "https://cccsdetectorsdeveussa01.blob.core.windows.net/c29038eb-207e-430e-bba3-1a1ce48ca9ae/traffic-signs-1.0.zip?sv=2024-08-04&se=2025-08-08T08%3A26%3A32Z&sr=b&sp=w&sig=***REMOVED***"
        }
    }
}

Response 400 Bad Request

The 400 (Bad Request) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json
{
    "error": {
        "code": "InvalidRealityAnalysisRequest",
        "message": "Cannot create detector version.",
        "details": [{
            "code": "InvalidProperty",
            "message": "Version must contain a major and minor version in x.x format.",
            "target": "versionNumber"
        }]
    }
}

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 409 Conflict

This response indicates that the user tried to create a resource that already exists.

json
{
    "error": {
        "code": "DetectorVersionExists",
        "message": "This version of the detector already exists.",
        "target": "versionNumber"
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json
{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

Name
Description
retry-after

Number of seconds to wait until client is allowed to make more requests.

Detector export type

Available types for AI library detector exports.

Name
Type
Description
Objects
String
Lines
String
Polygons
String
Locations
String

Detector version status

Available types for AI library detector version status.

Name
Type
Description
AwaitingData
String
Ready
String

Detector version create payload

Properties of the detector version to be created.

Name
Type
Description
versionNumber
String

Version number of the detector.

capabilities

Capabilities of the version.

Detector version create response

Response of detector version create operation.

Name
Type
Description
version

Detector version details.

_links

Contains the hyperlinks related to the detector version creation.

Detector version

Details of detector version.

Name
Type
Description
creationDate
Date-time

Creation date of the version.

versionNumber
String

Version number.

status

Status of the version.

creatorId
String

User Id of the version creator.

capabilities

Capabilities of the version.

Detector version creation links

Hyperlinks for further detector version upload and completion.

Name
Type
Description
completeUrl

URL to mark the completion of the detector version creation process.

uploadUrl

URL to upload the detector zip file.

link

Name
Type
Description
href
String

Hyperlink container.

Detector version capabilities

Capabilities of detector version.

Name
Type
Description
labels
String[]

Labels of the detector version.

exports

Exports of the detector version.

DetailedError

Contains error information and an array of more specific errors.

Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String, null

The target of the error.

details

Optional array of more specific errors.

Detailed Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

Name
Type
Description
error

Error Detailed information.

Error

Contains error information.

Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String, null

The target of the error.

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

Name
Type
Description
error

Error information.

Was this page helpful?