Reality Analysis
Download API definition:
This API is a Technical Preview and is available for testing purposes only. Do not use in production.
GET https://dev-api.bentley.com/realitydataanalysis/detectors

Retrieve all available detectors.

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

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

This response indicates that the request was successful.

json
{
    "detectors": [{
            "name": "@bentley/cracks-ortho",
            "displayName": "Cracks Ortho",
            "description": "Detects cracks in concrete infrastructure to enable defect inspection workflows.",
            "type": "OrthophotoSegmentationDetector",
            "documentationUrl": "https://www.bentley.com",
            "latestVersion": "1.0"
        },
        {
            "name": "traffic-signs",
            "displayName": "Traffic signs detector",
            "description": "Detects all traffic signs within a scene.",
            "type": "PhotoObjectDetector",
            "documentationUrl": "https://www.example.com"
        }
    ]
}

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 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 type

Available types for AI library detectors.

Name
Type
Description
PhotoObjectDetector
String
PhotoSegmentationDetector
String
OrthophotoSegmentationDetector
String
PointCloudSegmentationDetector
String

Reality Analysis detectors

List of available detectors.

Name
Type
Description
detectors

List of detectors.

Detector details

Details of a detector.

Name
Type
Description
name
String

Name of the detector.

displayName
String

Display name of the detector.

description
String

Description of the detector.

type

Type of the detector.

documentationUrl
String

Url of the detector's documentation.

latestVersion
String

The latest version of the detector with 'Ready' status, if any.

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?