Skip to main content
GET
Look Up Scribe Session

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Path Parameters

id
string
required

The session to look up — either your consultationInternalId, or the session id (ss_...) the API returns.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-][A-Za-z0-9._-]{0,127}$
Examples:

"CONSULT-12345"

"ss_sa98vgqyra91q5b8"

Response

Successful Response

Response body for session scribe lookup.

id
string
required
Maximum string length: 255
Example:

"ss_a1b2c3d4e5f6g7h8"

status
string
required
Maximum string length: 255
Example:

"completed"

createdAt
string<date-time> | null
Example:

"2026-02-20T10:00:00Z"

completedAt
string<date-time> | null
Example:

"2026-02-20T10:30:00Z"

patientName
string | null
Maximum string length: 255
Example:

"John Doe"

scribeSessionModality
string | null

The modality of the scribe session (e.g. 'IN_PERSON', 'TELEMEDICINE').

Example:

"IN_PERSON"

consultationInternalId
string | null

The consultation ID provided by the API consumer.

Example:

"CONSULT-12345"

specialty
string | null

The medical specialty of the clinician who conducted the session.

Example:

"Cardiology"

emrEncounterId
string | null

The EMR visit number the session is attached to (for MV, CD_ATENDIMENTO). Null when the session is not attached to a visit imported from the EMR.

Example:

"ENC-67890"

branch
SessionBranch · object | null

The institution branch (site) the session was recorded under. It is the clinician's branch when the session was created, not read from the EMR visit. Null when the session has no branch.