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://dev-api.bentley.com/realitydataanalysis/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.v1+json is recommended.

Response 200 OK

This response indicates that the request was successful.

json

{
    "detector": {
        "name": "cracks-detector",
        "description": "Cracks detector",
        "type": "PhotoObjectDetector",
        "documentationUrl": "https://www.bentley.com",
        "versions": [{
                "creationDate": "2025-03-18T14:11:15.5325351Z",
                "version": "2.0",
                "status": "AwaitingData",
                "creatorId": "e8be5445-c76a-41c6-9bfe-6a3d71953624",
                "capabilities": {
                    "labels": [
                        "crack"
                    ],
                    "exports": [
                        "Lines"
                    ]
                }
            },
            {
                "creationDate": "2025-03-12T13:32:06.8787916Z",
                "version": "1.1",
                "status": "Ready",
                "creatorId": "e8be5445-c76a-41c6-9bfe-6a3d71953624",
                "downloadUrl": "https://cicsdetectorsprodeussa01.blob.core.windows.net/bd9bf908-9b82-4fcd-9ab4-ff15286d2ada/cracks-detector-1.1.zip?sv=2024-08-04&se=2025-04-23T11%3A26%3A11Z&sr=b&sp=r&sig=***REMOVED***",
                "capabilities": {
                    "labels": [
                        "crack"
                    ]
                }
            },
            {
                "creationDate": "2025-03-11T15:11:24.2712971Z",
                "version": "1.0",
                "status": "Ready",
                "creatorId": "d2b5b8e7-8248-49a3-94ac-b097a7a67b6d",
                "downloadUrl": "https://cicsdetectorsprodeussa01.blob.core.windows.net/bd9bf908-9b82-4fcd-9ab4-ff15286d2ada/cracks-detector-1.0.zip?sv=2024-08-04&se=2025-04-23T11%3A26%3A11Z&sr=b&sp=r&sig=***REMOVED***",
                "capabilities": {
                    "labels": [
                        "Crack Object"
                    ],
                    "exports": [
                        "Lines"
                    ]
                }
            }
        ]
    }
}

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

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

Capabilities of detector version

labels

String[]

Labels of the detector version.

exports

detector-export-type[]

Exports of the detector version.

json

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

Detector response

detector

detector-get-details

Detector details.

json

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

Detector details

name

String

Name of the detector.

description

String

Description of the detector.

type

detector-type

Type of the detector.

documentationUrl

String

Url of the detector's documentation.

versions

detector-version-complete[]

All existing versions of the detector.

json

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

Detector version

creationDate

Date-time

Creation date of the version.

version

String

Version number.

status

detector-version-status

Status of the version.

downloadUrl

String

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

creatorId

String

User Id of the version creator.

capabilities

detector-version-capabilities

Capabilities of the version.

json

{
    "title": "Detector version",
    "type": "object",
    "properties": {
        "creationDate": {
            "description": "Creation date of the version.",
            "type": "string",
            "format": "date-time"
        },
        "version": {
            "description": "Version number.",
            "type": "string"
        },
        "status": {
            "description": "Status of the version.",
            "$ref": "#/components/schemas/detector-version-status"
        },
        "downloadUrl": {
            "description": "URL to download the detector version. It is present only if the version status is 'Ready'.",
            "type": "string"
        },
        "creatorId": {
            "description": "User Id of the version creator.",
            "type": "string"
        },
        "capabilities": {
            "description": "Capabilities of the version.",
            "$ref": "#/components/schemas/detector-version-capabilities"
        }
    },
    "required": [
        "creationDate",
        "version",
        "status"
    ],
    "additionalProperties": false
}

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

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

Detector export type

Detector version status

Capabilities of detector version

Detector response

Detector details

Detector version

Error

Error Response