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
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.
Request body
Detector create payload
Name of the detector.
An optional display name of the detector.
An optional description of the detector.
An optional URL to the detector's documentation.
Example
{ "name": "traffic-signs", "displayName": "Traffic signs detector", "description": "Detects all traffic signs within a scene.", "type": "PhotoObjectDetector", "documentationUrl": "https://www.bentley.com" }
Response 201 Created
This response indicates that the detector was successfully created.
{ "detector": { "name": "traffic-signs", "displayName": "Traffic signs detector", "description": "Detects all traffic signs within a scene.", "type": "PhotoObjectDetector", "documentationUrl": "https://www.bentley.com", "versions": [] } }
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).
{ "error": { "code": "InvalidRealityAnalysisRequest", "message": "Cannot create detector.", "details": [{ "code": "InvalidValue", "message": "Invalid detector type.", "target": "detector.type" }] } }
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.
{ "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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Detector type
Available types for AI library detectors.
{ "title": "Detector type", "enum": [ "PhotoObjectDetector", "PhotoSegmentationDetector", "OrthophotoSegmentationDetector", "PointCloudSegmentationDetector" ], "description": "Available types for AI library detectors." }
Detector create payload
Properties of the detector to be created.
Name of the detector.
An optional display name of the detector.
An optional description of the detector.
An optional URL to the detector's documentation.
{ "title": "Detector create payload", "description": "Properties of the detector to be created.", "type": "object", "properties": { "name": { "description": "Name of the detector.", "type": "string" }, "displayName": { "description": "An optional display name of the detector.", "type": "string" }, "description": { "description": "An optional description of the detector.", "type": "string" }, "type": { "description": "Type of the detector.", "$ref": "#/components/schemas/DetectorType" }, "documentationUrl": { "description": "An optional URL to the detector's documentation.", "type": "string" } }, "required": [ "name", "type" ], "additionalProperties": false }
Detector create response
Response of detector create operation.
{ "title": "Detector create response", "description": "Response of detector create operation.", "type": "object", "properties": { "detector": { "description": "Detector details.", "$ref": "#/components/schemas/DetectorCreateResponseDetails" } }, "required": [ "detector" ], "additionalProperties": false }
Detector details
Details of detector.
Name of the detector.
Display name of the detector.
Description of the detector.
Url of the detector's documentation.
All existing versions of the detector.
{ "title": "Detector details", "description": "Details of detector.", "type": "object", "properties": { "name": { "description": "Name of the detector.", "type": "string" }, "displayName": { "description": "Display name of the detector.", "type": "string" }, "description": { "description": "Description of the detector.", "type": "string" }, "type": { "description": "Type of the detector.", "$ref": "#/components/schemas/DetectorType" }, "documentationUrl": { "description": "Url of the detector's documentation.", "type": "string" }, "versions": { "description": "All existing versions of the detector.", "type": "array" } }, "required": [ "name", "type", "versions" ], "additionalProperties": false }
DetailedError
Contains error information and an array of more specific errors.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information and an array of more specific errors.", "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", "description": "Optional array of more specific errors.", "items": { "$ref": "#/components/schemas/Error" } } }, "required": [ "code", "message", "details" ], "additionalProperties": true }
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.
{ "type": "object", "title": "Detailed 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 Detailed information.", "$ref": "#/components/schemas/DetailedError" } }, "required": [ "error" ], "additionalProperties": false }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "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.
{ "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?