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.
The Dragon standard payload contains a recordings object, a sessions object, and a transcript object. The recordings object contains details about the recordings that exist for an encounter. The transcript object contains the full transcript for all recordings in the encounter.
Example payload
{
"recordings": [
{
"recording_id": 123456,
"status": "delivered",
"transcript_reference": "https://api.dragoncopilot.com/transcripts/123456",
"source": "DAXAPP",
"template_id": "template-001",
"start_datetime": "2025-06-18T14:00:00Z",
"end_datetime": "2025-06-18T14:30:00Z"
}
],
"sessions": [
{
"dax_session_id": "f5f00a91-ffbb-43da-9540-770865fe3d76",
"user_id": "d07bb61d-114f-439a-a678-53767f69f692",
"organization_id": "b5a273f1-6884-406c-969b-c140f77d5078"
}
],
"transcript": {
"speaker_count": 2,
"turns": [
{
"index": 1,
"speaker": "clinician",
"text": "Good afternoon, how are you feeling today?",
"start_time": "00:00:01.000",
"end_time": "00:00:05.000"
},
{
"index": 2,
"speaker": "other",
"text": "I'm feeling much better, thank you.",
"start_time": "00:00:06.000",
"end_time": "00:00:09.000"
}
]
}
}
Recordings schema properties
The recordings object contains the following properties:
| Property | Type | Description | Allowed values/format |
|---|---|---|---|
recording_id |
integer | The unique identifier for the recording. Internally this is the DAX session_id. | |
status |
string | This represents the state of the recording and the processing of data related to the recording. | uploading, processing, reviewing, delivered |
transcript_reference |
string | URL to retrieve the recording transcript. | format: uri |
source |
string | The source of the recording. The means in which the audio signal or user input was acquired. | DAXAPP, DAXKIT.haiku, DAXKIT.teams, PMM |
template_id |
string | The ID, represented as a string to allow for variations across utilization, for the template utilized. | |
start_datetime |
string | The start date and time of the recording in ISO 8601 format. | format: date-time |
end_datetime |
string | The end date and time of the recording in ISO 8601 format. | format: date-time |
Session schema properties
The sessions object contains the following properties:
| Property | Type | Description | Allowed values/format |
|---|---|---|---|
dax_session_id |
string | The unique identifier for the DAX session. | format: uuid |
user_id |
string | The unique identifier for the user associated with the session. | format: uuid |
organization_id |
string | The unique identifier for the organization associated with the session. | format: uuid |
Transcript schema properties
The transcript object contains the following properties:
| Property | Type | Description | Constraints / Format |
|---|---|---|---|
speaker_count |
integer | The total number of unique speakers in the transcript. | minimum: 1 |
turns |
array | List of speaker turns in the transcript. | |
└─ index |
integer | The sequential index of the turn. | |
└─ speaker |
string | The name or role of the speaker. | "clinician" or "other" |
└─ text |
string | The transcribed text spoken by the speaker. | |
└─ start_time |
string | Start time in HH:MM:SS.sss format. | pattern: ^\d{2}:\d{2}:\d{2}\.\d{3}$ |
└─ end_time |
string | End time in HH:MM:SS.sss format. | pattern: ^\d{2}:\d{2}:\d{2}\.\d{3}$ |