Skip to main content
GET
Get a session's audit

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_-]+$
Examples:

"CONSULT-12345"

"ss_sa98vgqyra91q5b8"

Response

Successful Response

A scribe session's clinical-quality audit.

id
string
required

Stable audit identifier.

Example:

"au_a1b2c3d4e5f6g7h8"

score
number | null

Weighted total quality score, 0..1.

Example:

0.82

grade
string | null

Qualitative grade of the score.

Example:

"ACEPTABLE"

reviewStatus
string | null

Human-review state: 'pending', 'inReview', or 'reviewed'.

origin
string | null

How the audit was created (e.g. 'scribe').

Example:

"scribe"

createdAt
string<date-time> | null
configuration
AuditConfigurationRef · object | null

The rubric this audit was scored against (null for legacy audits).

sections
AuditSection · object[]

Per-section scores with their labels.