Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
DAX Copilot Partner APIs are a set of REST APIs that enable healthcare IT partners to integrate with Dragon Copilot. They make it easy for you to integrate clinical workflow, content and data using industry standard technology.
The Partner API suite enables seamless integration of Dragon Copilot into partner applications, supporting various use cases and enhancing the overall business workflow.
Partner APIs include the following functionality:
License service: Check if a user has a license to use Dragon Copilot embedded in partner technology.
Dragon Data Exchange: Exchange data between a partner service and a Microsoft application service.
Ambient session service: Control an ambient recording session.
Configuration service: Provide configuration information to Microsoft Health and Life Sciences applications.
Audio service (preview): Upload audio files and start AI processing.
Example workflow
The License API can be utilized in the partner's end-user facing application to verify user eligibility for Dragon Copilot.
Before starting an ambient conversation recording, partners can call the Ambient Session API and provide patient context, such as demographics and encounter details, allowing Dragon Copilot to prepare for processing the recording.
During the ambient conversation recording, partners have two options to send audio to Dragon Copilot:
- DAXKit for streaming audio.
- Audio Service (preview) for audio file uploads.
Dragon Copilot processes the recording, generating artifacts like audio transcripts and AI-generated notes. These artifacts are delivered asynchronously to the partner via the Dragon Data Exchange (DDE) service, which offers APIs for receiving information using a pub-sub model and providing feedback on the AI-generated artifacts.
The Configuration API allows partners to customize Dragon Copilot's output by providing configuration details. For example, partners can use this API to pass custom field mappings, enabling Dragon Copilot to tailor its AI-generated responses.
Base URL
The Partner APIs are located at the following URLs for production and non-production environments:
| Region | Environment | URL |
|---|---|---|
| US | Non-production | https://partnerapi.qa.ppe-copilot.us.dragon.com/ |
| US | Production | https://partnerapi.copilot.us.dragon.com/ |
| Canada (preview) | Production | https://partnerapi.copilot.ca.dragon.com |
| France (preview) | Production | https://partnerapi.copilot.fr.dragon.com |
| Germany (preview) | Production | https://partnerapi.copilot.de.dragon.com |
| UK (preview) | Production | https://partnerapi.copilot.uk2.dragon.com |
API authentication
Partner APIs are secured with access tokens issued by your identity solution. The recommended identity solution is Microsoft Entra ID, but Partner APIs accept access tokens issued by different identity solutions as long as the following requirements are met:
- The access token is in JSON Web Token (JWT) format and conforms to RFC 9068.
- The metadata for your JWT issuer is available on the public internet at: <issuer>/.well-known/openid-configuration
- The audience claim of the access token matches the audience claim specified by the partner API.
- The identity solution has been added to the partner API allow list.
Allow list
Regardless of the identity solution you use, it must be added to the list of allowed Partner API access token issuers. Adding an identity solution to the allow list requires the following information:
- Your partner ID.
- The value of the JWT issuer (
iss) claim. - The name of the JWT claim used to identify the service principal represented by the access token.
- The values of the JWT claim used to identify the service principal represented by the access token.
You can add multiple access token issuers to the allow list. For each issuer, you must specify the JWT claim used to identify the service principal and the possible values for that claim.
Provide this information to your Dragon partner relations team.
Authorization
All APIs of the service require an access token issued by your identity solution. The audience claim of the access token is valued based on the environment.
| Environment | Allowed values |
|---|---|
| Non-production | c63cd8c7-713f-43bf-b47c-f7a4b9c83738 |
| Production | 105be974-d66d-43c9-b813-57a967bbfd21 |
Using Entra ID as the identity solution
When you use Entra ID as the identity solution, obtaining an access token with the appropriate claims requires you to add the Partner APIs' Microsoft Entra enterprise applications to your Microsoft Entra tenant. For more information, see Use Entra ID as your identity solution.
Product identifiers
| Product name | ID |
|---|---|
| Dragon Copilot | 4f939ade-287a-416d-8484-1e64013039dd |
REST API error responses
Partner APIs provide a standardized error response in JSON format.
The JSON schema is as follows:
{
"title": "<A brief description of the error>",
"messages": [
"<An array of one or more messages describing the error in detail>"
]
}