Create detector version - Reality Analysis

Reality Analysis

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Create detector version

POST https://qa-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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Detector version create payload

versionNumber

String

Yes

Version number of the detector.

capabilities

DetectorVersionCapabilities

Yes

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:30Z",
        "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"
        }]
    }
}

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 404 Not Found

This response indicates that the requested operation or resource could not be found.

json

{
    "error": {
        "code": "ResourceNotFound",
        "message": "The requested resource was not found. Verify the API URL and the Accept header.",
        "details": [{
            "code": "OperationNotFound",
            "message": "Unable to match incoming request to an operation."
        }]
    }
}

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

retry-after

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

Definitions

Error

Contains error information.

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.

json

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "description": "Contains error information."
}

DetailedError

Contains error information and an array of more specific errors.

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

Error[]

Optional array of more specific errors.

json

{
    "required": [
        "code",
        "message",
        "details"
    ],
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        }
    },
    "description": "Contains error information and an 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.

error

DetailedError

json

{
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "additionalProperties": false,
    "description": "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."
}

Error Response

error

Error

json

{
    "title": "Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error"
        }
    },
    "additionalProperties": false,
    "description": "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."
}

Detector version status

Available types for AI library detector version status.

AwaitingData

String

Ready

String

json

{
    "title": "Detector version status",
    "enum": [
        "AwaitingData",
        "Ready"
    ],
    "description": "Available types for AI library detector version status."
}

Detector export type

Available types for AI library detector exports.

Objects

String

Lines

String

Polygons

String

Locations

String

json

{
    "title": "Detector export type",
    "enum": [
        "Objects",
        "Lines",
        "Polygons",
        "Locations"
    ],
    "description": "Available types for AI library detector exports."
}

Detector version capabilities

Capabilities of detector version.

labels

String[]

Labels of the detector version.

exports

DetectorExportType[], null

Exports of the detector version.

json

{
    "title": "Detector version capabilities",
    "required": [
        "labels"
    ],
    "type": "object",
    "properties": {
        "labels": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Labels of the detector version."
        },
        "exports": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/DetectorExportType"
            },
            "description": "Exports of the detector version.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Capabilities of detector version."
}

Detector version

Details of detector version.

creationDate

Date-time

Creation date of the version.

versionNumber

String

Version number.

status

DetectorVersionStatus

creatorId

String, null

User Id of the version creator.

capabilities

DetectorVersionCapabilities

json

{
    "title": "Detector version",
    "required": [
        "creationDate",
        "versionNumber",
        "status",
        "capabilities"
    ],
    "type": "object",
    "properties": {
        "creationDate": {
            "type": "string",
            "description": "Creation date of the version.",
            "format": "date-time"
        },
        "versionNumber": {
            "type": "string",
            "description": "Version number."
        },
        "status": {
            "$ref": "#/components/schemas/DetectorVersionStatus"
        },
        "creatorId": {
            "type": "string",
            "description": "User Id of the version creator.",
            "default": null,
            "nullable": true
        },
        "capabilities": {
            "$ref": "#/components/schemas/DetectorVersionCapabilities"
        }
    },
    "additionalProperties": false,
    "description": "Details of detector version."
}

Detector version create payload

Properties of the detector version to be created.

versionNumber

String

Version number of the detector.

capabilities

DetectorVersionCapabilities

json

{
    "title": "Detector version create payload",
    "required": [
        "versionNumber",
        "capabilities"
    ],
    "type": "object",
    "properties": {
        "versionNumber": {
            "type": "string",
            "description": "Version number of the detector."
        },
        "capabilities": {
            "$ref": "#/components/schemas/DetectorVersionCapabilities"
        }
    },
    "additionalProperties": false,
    "description": "Properties of the detector version to be created."
}

Link

href

String

The URL.

json

{
    "required": [
        "href"
    ],
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "The URL."
        }
    },
    "additionalProperties": false
}

Detector version creation links

Hyperlinks for further detector version upload and completion.

completeUrl

Link

uploadUrl

Link

json

{
    "title": "Detector version creation links",
    "required": [
        "completeUrl",
        "uploadUrl"
    ],
    "type": "object",
    "properties": {
        "completeUrl": {
            "$ref": "#/components/schemas/Link"
        },
        "uploadUrl": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false,
    "description": "Hyperlinks for further detector version upload and completion."
}

Detector version create response

Response of detector version create operation.

version

DetectorVersion

_links

DetectorVersionCreateResponseLinks

json

{
    "title": "Detector version create response",
    "required": [
        "version",
        "_links"
    ],
    "type": "object",
    "properties": {
        "version": {
            "$ref": "#/components/schemas/DetectorVersion"
        },
        "_links": {
            "$ref": "#/components/schemas/DetectorVersionCreateResponseLinks"
        }
    },
    "additionalProperties": false,
    "description": "Response of detector version create operation."
}

Was this page helpful?

Authentication

Request

Request parameters

Request headers

Request body

Detector version create payload

Example

Response

Response 201 Created

Response 400 Bad Request

Response 401 Unauthorized

Response 404 Not Found

Response 409 Conflict

Response 429 Too many requests

Response headers

Definitions

Error

DetailedError

Detailed Error Response

Error Response

Detector version status

Detector export type

Detector version capabilities

Detector version

Detector version create payload

Link

Detector version creation links

Detector version create response