Skip to main content
POST
Start a live consultation audio session

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Body

application/json

The consultation metadata: the multipart metadata part, or the JSON body.

consultation
ConsultationInput · object
required

The caller's consultation reference.

template
TemplateInput · object
required

Template selection: an existing public id xor an inline structured template.

patient
PatientInput · object
required

An existing patient by public id xor the inline identity.

context
ContextInput · object | null

Free-text context that feeds record generation.

Response

Successful Response

201 response: the batch envelope plus the streaming URL.

consultation
ConsultationRef · object
required

Echo of the caller's consultation reference.

live
LiveSessionInfo · object
required

Where and until when the caller can stream the consultation audio.

status
string
default:created

Always created on success. Stream the audio to live.url; completion then follows the batch contract described on status above.

Allowed value: "created"