Create detector - Reality Analysis

Reality Analysis

This API is deprecated. Please upgrade to the current version of this API as soon as possible.

Create detector

post https://qa-api.bentley.com/realitydataanalysis/detectors

Create a new detector.

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.v1+json is recommended.

Example

json

{
    "detector": {
        "name": "traffic-signs",
        "displayName": "Traffic signs detector",
        "description": "Detects all traffic signs within a scene.",
        "type": "PhotoObjectDetector",
        "documentationUrl": "https://www.bentley.com",
        "version": "1.0",
        "labels": ["signs"],
        "exports": ["Objects"]
    }
}

Response 201 Created

This response indicates that the detector was successfully created.

json

{
    "detector": {
        "name": "traffic-signs",
        "displayName": "Traffic signs detector",
        "description": "Detects all traffic signs within a scene.",
        "type": "PhotoObjectDetector",
        "documentationUrl": "https://www.bentley.com",
        "versions": [{
            "creationDate": "2025-04-16T12:11:48.8662984+00:00",
            "version": "1.0",
            "status": "AwaitingData",
            "creatorId": "b4ebc9f7-31b3-482f-a2be-aaeb91516ebc",
            "capabilities": {
                "labels": ["signs"],
                "exports": ["Objects"]
            }
        }]
    },
    "_links": {
        "completeUrl": {
            "href": "detectors/traffic-signs/version/1.0/complete"
        },
        "uploadUrl": {
            "href": "https://cicsdetectorseussa01.blob.core.windows.net/78e3a82d-076e-4d1d-b8ef-ab0625fbb856/traffic-signs-1.0.zip?sv=2024-08-04&se=2025-04-16T12%3A31%3A48Z&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": "InvalidRealityDataAnalysisRequest",
        "message": "Cannot create detector.",
        "details": [{
            "code": "InvalidValue",
            "message": "Invalid detector type.",
            "target": "detector.type"
        }]
    }
}

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

{
    "$ref": "#/components/examples/401.HeaderNotFound.example"
}

Response 409 Conflict

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

json

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

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

link

href

String

Hyperlink container.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink container."
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

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

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

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

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

Error

Error information.

json

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

Detector type

Available types for AI library detectors.

PhotoObjectDetector

String

PhotoSegmentationDetector

String

OrthophotoSegmentationDetector

String

PointCloudSegmentationDetector

String

json

{
    "enum": [
        "PhotoObjectDetector",
        "PhotoSegmentationDetector",
        "OrthophotoSegmentationDetector",
        "PointCloudSegmentationDetector"
    ],
    "title": "Detector type",
    "description": "Available types for AI library detectors."
}

Detector version

Details of detector version.

status

detector-version-status

version

String

Version number.

creatorId

String

User Id of the version creator.

capabilities

detector-version-capabilities

creationDate

Date-time

Creation date of the version.

json

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

Detector details

Details of detector.

name

String

Name of the detector.

type

detector-type

versions

detector-version[]

All existing versions of the detector.

description

String

Description of the detector.

displayName

String

Display name of the detector.

documentationUrl

String

Url of the detector's documentation.

json

{
    "type": "object",
    "title": "Detector details",
    "required": [
        "name",
        "type",
        "versions"
    ],
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the detector."
        },
        "type": {
            "$ref": "#/components/schemas/detector-type"
        },
        "versions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/detector-version"
            },
            "description": "All existing versions of the detector."
        },
        "description": {
            "type": "string",
            "description": "Description of the detector."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the detector."
        },
        "documentationUrl": {
            "type": "string",
            "description": "Url of the detector's documentation."
        }
    },
    "description": "Details of detector.",
    "additionalProperties": false
}

Detector export type

Available types for AI library detector exports.

Objects

String

Lines

String

Polygons

String

Locations

String

json

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

Detailed Error Response

error

DetailedError

Error Detailed information.

json

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

Detector create details

Properties of the detector to be created.

name

String

Name of the detector.

type

detector-type

labels

String[]

Labels of the detector.

exports

detector-export-type[]

Optional exports of the detector.

version

String

Version of the detector in X.Y format.

description

String

An optional description of the detector.

displayName

String

An optional display name of the detector.

documentationUrl

String

An optional URL to the detector's documentation.

json

{
    "type": "object",
    "title": "Detector create details",
    "required": [
        "name",
        "type",
        "version",
        "labels"
    ],
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the detector."
        },
        "type": {
            "$ref": "#/components/schemas/detector-type"
        },
        "labels": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Labels of the detector."
        },
        "exports": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/detector-export-type"
            },
            "description": "Optional exports of the detector."
        },
        "version": {
            "type": "string",
            "description": "Version of the detector in X.Y format."
        },
        "description": {
            "type": "string",
            "description": "An optional description of the detector."
        },
        "displayName": {
            "type": "string",
            "description": "An optional display name of the detector."
        },
        "documentationUrl": {
            "type": "string",
            "description": "An optional URL to the detector's documentation."
        }
    },
    "description": "Properties of the detector to be created.",
    "additionalProperties": false
}

Detector create payload

detector

detector-create-details

json

{
    "type": "object",
    "title": "Detector create payload",
    "required": [
        "detector"
    ],
    "properties": {
        "detector": {
            "$ref": "#/components/schemas/detector-create-details"
        }
    },
    "additionalProperties": false
}

Detector version status

Available types for AI library detector version status.

AwaitingData

String

Ready

String

json

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

Detector create response

Response of detector create operation.

_links

detector-create-response-links

detector

detector-response

json

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

Detector version capabilities

Capabilities of detector version.

labels

String[]

Labels of the detector version.

exports

detector-export-type[]

Exports of the detector version.

json

{
    "type": "object",
    "title": "Detector version capabilities",
    "properties": {
        "labels": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Labels of the detector version."
        },
        "exports": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/detector-export-type"
            },
            "description": "Exports of the detector version."
        }
    },
    "description": "Capabilities of detector version.",
    "additionalProperties": false
}

Detector creation links

Hyperlinks for further detector version upload and completion.

uploadUrl

link

completeUrl

link

json

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

Was this page helpful?

Authentication

Request

Request headers

Request body

Detector create payload

Example

Response

Response 201 Created

Response 400 Bad Request

Response 401 Unauthorized

Response 409 Conflict

Response 429 Too many requests

Response headers

Definitions

link

Error

DetailedError

Error Response

Detector type

Detector version

Detector details

Detector export type

Detailed Error Response

Detector create details

Detector create payload

Detector version status

Detector create response

Detector version capabilities

Detector creation links