How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dentsply Sirona Intraoral Imaging Modality API

A 17-operation OpenAPI 3.0.1 contract for acquisition and control of Dentsply Sirona intraoral sensors. Devices operations retrieve names, icons, battery and status for connected USB and WiFi sensor interfaces; Acquisition operations open a capture session, arm the sensor with per-exposure AcquisitionInfo, and retrieve the resulting image media and previews. Two Server-Sent Events channels push device events and acquisition-status transitions. This is a LOCAL service: it runs as the Sensor Plugin service on the practice workstation, so its declared server is https://localhost:43809/api/dsio/modality/v1 rather than a cloud host. Authentication is HTTP Basic with an API key Dentsply Sirona issues directly to approved developers.

Dentsply Sirona Intraoral Imaging Modality API is one of 4 APIs that Dentsply Sirona publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include GitHub, Imaging, Intraoral, Modality, and Sensors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and a changelog.

This API exposes 17 operations across 13 paths, organized into 2 resource areas, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://localhost:43809/api/dsio/modality/v1.

17 operations 13 paths 14 schemas 1 DELETE13 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://localhost:43809/api/dsio/modality/v1
Authentication
HTTP Basic
Resource Areas
2

Authentication & Security 1

Dentsply Sirona Intraoral Imaging Modality API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 1 DELETE, 13 GET, 1 POST, 2 PUT. They span 2 resource areas: Devices, Images. Each is listed below with its method, path, parameters, and response codes.

Devices 4

The device management API provides methods to retrieve information, such as names, icons and status for devices.

GET
/devices
Get All Devices
getAllDevices → 200
GET
/devices/subscribe
Subscribe to Device Events
subscribeDevices 1 param → 200
GET
/devices/{deviceId}
Get Device Information
getDeviceInfo 1 param → 200404
GET
/devices/{deviceId}/sensor
Get Sensor Information
getSensorInfo 1 param → 200404
Images 13

The Acquisition API provides methods to acquire one or more images from a device.

POST
/acquisition
Create Acquisition Session
createAcquisitionSession body → 201404409500507
GET
/acquisition
Get Acquisition Sessions
getSessions 1 param → 200
GET
/acquisition/{sessionId}
Get Acquisition Session
getAcquisitionSession 1 param → 200404
PUT
/acquisition/{sessionId}
Update Acquisition Session
updateAcquisitionSession 1 param body → 200404409
DELETE
/acquisition/{sessionId}
Delete Acquisition Session
deleteAcquisitionSession 1 param → 200404
GET
/acquisition/{sessionId}/status
Get Acquisition Status
getAcquisitionStatus 1 param → 200404
GET
/acquisition/{sessionId}/status/subscribe
Subscribe to Acquisition Status Events
subscribeAcquisitionStatus 2 params → 200404
GET
/acquisition/{sessionId}/info
Get Acquisition Information
getAcquisitionInfo 1 param → 200404
PUT
/acquisition/{sessionId}/info
Update Acquisition Information
setAcquisitionInfo 1 param body → 200400404423
GET
/acquisition/{sessionId}/images
Get All Images
getImages 1 param → 200404
GET
/acquisition/{sessionId}/images/{imageId}
Get Image
getImage 2 params → 200404
GET
/acquisition/{sessionId}/images/{imageId}/media
Get Image Media
getImageMedia 2 params → 200404
GET
/acquisition/{sessionId}/images/{imageId}/preview
Get Image Preview Media
getImagePreview 2 params → 200404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ImageInfo (16 properties), DeviceInfo (10 properties), SensorInfo (9 properties), LutInfo (6 properties). Each schema is shown below with its type and property counts.

DeviceStatus
string
Describes the current status of the device: Available - Device is available for an acquisition InUse - Device is currently being used for an acquisition Unavai…
DeviceEventData
object
Describes changes to the list of devices including added, removed and changed devices. A device may change if a different sensor is connected causing the name…
1 property
Heartbeat
object
Contains the timeout interval for a heartbeat message sent to subscribed clients.
1 property
DeviceInfo
object
Detailed information about an intraoral device (sensor interface)
10 properties
BatteryInfo
object
Contains information about the current state of the battery in the device if applicable.
3 properties
SensorInfo
object
Detailed information about an intraoral sensor.
9 properties
AcquisitionSessionInfo
object
Information used to create or update an acquisition session
3 properties
AcquisitionSession
object
Information about an active acquisition session. This object is similar to AcquisitionSessionInfo, but with the addition of the session Id.
5 properties
AcquisitionStatus
object
Describes the state of the current exposure
4 properties
AcquisitionInfo
object
Provides information regarding an acquisition. AcquisitionInfo must be provided prior to each exposure.
5 properties
ExposureInfo
object
Describes the quality of the exposure. The optimal range is defined by [low, high], with an optimal exposure value defined by optimal If the exposure value is…
6 properties
LutInfo
object
Describes the lookup table (LUT) mapping applied to an image. Images acquired by this service may be mapped using a non-linear LUT in order to provide an image…
6 properties
HashInfo
object
A hash used to verify integrity of pixel data.
2 properties
ImageInfo
object
Provides detailed information about acquired images, including the format of the image data and URLs that can be used to retrieve image data. The device does n…
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dentsply-sirona-intraoral-modality-openapi.yml Raw ↑

Other APIs Dentsply Sirona publishes across the network.

DS Core API
Dentsply Sirona Intraoral Imaging Filters API
Intraoral Exposure API
Where this information came from

This is an independent, third-party profile of Dentsply Sirona Intraoral Imaging Modality API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.