Get detector - 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.

Get detector

GET https://qa-api.bentley.com/reality-analysis/detectors/{detectorName}

Retrieve details of a 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.v2+json is recommended.

Response 200 OK

This response indicates that the request was successful.

json

{
    "detector": {
        "name": "cracks-detector",
        "displayName": "Cracks detector",
        "description": "Detects all the cracks within a scene.",
        "type": "PhotoObjectDetector",
        "documentationUrl": "https://www.bentley.com",
        "versions": [{
            "creationDate": "2025-08-08T08:13:00Z",
            "versionNumber": "2.0",
            "status": "AwaitingData",
            "creatorId": "4f2d47ac-e318-46dc-ae53-06d71c9ff79e",
            "capabilities": {
                "labels": ["Cracks"],
                "exports": ["Objects"]
            }
        }, {
            "creationDate": "2025-08-08T08:06:30Z",
            "versionNumber": "1.0",
            "status": "Ready",
            "creatorId": "4f2d47ac-e318-46dc-ae53-06d71c9ff79e",
            "capabilities": {
                "labels": ["Cracks"],
                "exports": ["Objects"]
            },
            "downloadUrl": "https://cccsdetectorsdeveussa01.blob.core.windows.net/c29038eb-207e-430e-bba3-1a1ce48ca9ae/cracks-detector-1.0.zip?sv=2024-08-04&se=2025-08-08T09%3A21%3A37Z&sr=b&sp=r&sig=eyGf9V%2BARcUaWYcjaw6znIb2Hbe7suONrlqYwR8ZvRc%3D"
        }]
    }
}

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 specified detector was not found.

json

{
    "error": {
        "code": "DetectorNotFound",
        "message": "Requested detector is not available."
    }
}

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

Detector type

Available types for AI library detectors.

PhotoObjectDetector

String

PhotoSegmentationDetector

String

OrthophotoSegmentationDetector

String

PointCloudSegmentationDetector

String

json

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

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."
}

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

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

downloadUrl

String, null

URL to download the detector version. It is present only if the version status is 'Ready'.

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"
        },
        "downloadUrl": {
            "type": "string",
            "description": "URL to download the detector version. It is present only if the version status is 'Ready'.",
            "default": null,
            "nullable": true
        },
        "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 details

Details of detector.

name

String

Name of the detector.

displayName

String, null

Display name of the detector.

description

String, null

Description of the detector.

type

DetectorType

documentationUrl

String, null

Url of the detector's documentation.

versions

DetectorVersionDetailed[]

All existing versions of the detector.

json

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

Detector response

detector

DetectorDetailed

json

{
    "title": "Detector response",
    "required": [
        "detector"
    ],
    "type": "object",
    "properties": {
        "detector": {
            "$ref": "#/components/schemas/DetectorDetailed"
        }
    },
    "additionalProperties": false
}

Was this page helpful?

Authentication

Request

Request parameters

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Detector type

Error

Error Response

Detector version status

Detector export type

Detector version capabilities

Detector version

Detector details

Detector response