Create a new detector version.
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 parameters
Request headers
OAuth access token with itwin-platform
scope
Setting to application/vnd.bentley.itwin-platform.v2+json
is recommended.
Request body
Detector version create payload
Version number of the detector.
Example
{ "versionNumber": "2.0", "capabilities": { "labels": [ "signs" ], "exports": [ "Objects" ] } }
Response 201 Created
This response indicates that the detector version was successfully created.
{ "version": { "creationDate": "2025-08-08T08:06:30.2466033Z", "versionNumber": "1.0", "status": "AwaitingData", "creatorId": "4f2d47ac-e318-46dc-ae53-06d71c9ff79e", "capabilities": { "labels": [ "signs" ], "exports": [ "Objects" ] } }, "_links": { "completeUrl": { "href": "detectors/traffic-signs/version/1.0/complete" }, "uploadUrl": { "href": "https://cccsdetectorsdeveussa01.blob.core.windows.net/c29038eb-207e-430e-bba3-1a1ce48ca9ae/traffic-signs-1.0.zip?sv=2024-08-04&se=2025-08-08T08%3A26%3A32Z&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).
{ "error": { "code": "InvalidRealityAnalysisRequest", "message": "Cannot create detector version.", "details": [{ "code": "InvalidProperty", "message": "Version must contain a major and minor version in x.x format.", "target": "versionNumber" }] } }
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 409 Conflict
This response indicates that the user tried to create a resource that already exists.
{ "error": { "code": "DetectorVersionExists", "message": "This version of the detector already exists.", "target": "versionNumber" } }
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 export type
Available types for AI library detector exports.
{ "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.
{ "title": "Detector version status", "enum": [ "AwaitingData", "Ready" ], "description": "Available types for AI library detector version status." }
Detector version create payload
Properties of the detector version to be created.
Version number of the detector.
{ "title": "Detector version create payload", "description": "Properties of the detector version to be created.", "type": "object", "properties": { "versionNumber": { "description": "Version number of the detector.", "type": "string" }, "capabilities": { "description": "Capabilities of the version.", "$ref": "#/components/schemas/DetectorVersionCapabilities" } }, "required": [ "versionNumber", "capabilities" ], "additionalProperties": false }
Detector version create response
Response of detector version create operation.
Contains the hyperlinks related to the detector version creation.
{ "title": "Detector version create response", "description": "Response of detector version create operation.", "type": "object", "properties": { "version": { "description": "Detector version details.", "$ref": "#/components/schemas/DetectorVersion" }, "_links": { "description": "Contains the hyperlinks related to the detector version creation.", "$ref": "#/components/schemas/DetectorVersionCreateResponseLinks" } }, "required": [ "version", "_links" ], "additionalProperties": false }
Detector version
Details of detector version.
Creation date of the version.
Version number.
User Id of the version creator.
{ "title": "Detector version", "description": "Details of detector version.", "type": "object", "properties": { "creationDate": { "description": "Creation date of the version.", "type": "string", "format": "date-time" }, "versionNumber": { "description": "Version number.", "type": "string" }, "status": { "description": "Status of the version.", "$ref": "#/components/schemas/DetectorVersionStatus" }, "creatorId": { "description": "User Id of the version creator.", "type": "string" }, "capabilities": { "description": "Capabilities of the version.", "$ref": "#/components/schemas/DetectorVersionCapabilities" } }, "required": [ "creationDate", "versionNumber", "status" ], "additionalProperties": false }
Detector version creation links
Hyperlinks for further detector version upload and completion.
{ "title": "Detector version creation links", "description": "Hyperlinks for further detector version upload and completion.", "type": "object", "properties": { "completeUrl": { "description": "URL to mark the completion of the detector version creation process.", "$ref": "#/components/schemas/link" }, "uploadUrl": { "description": "URL to upload the detector zip file.", "$ref": "#/components/schemas/link" } }, "required": [ "completeUrl", "uploadUrl" ], "additionalProperties": false }
link
Hyperlink container.
{ "type": "object", "properties": { "href": { "type": "string", "description": "Hyperlink container." } }, "additionalProperties": false }
Detector version capabilities
Capabilities of detector version.
Labels of the detector version.
{ "title": "Detector version capabilities", "description": "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/DetectorExportType" } } }, "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?