Skip to main content
An audit scores a completed scribe session’s medical record against a rubric (an audit configuration). It returns a weighted total on a 0..1 scale, a qualitative grade, and a per-section breakdown.
Audit reads follow your API key’s role. A session’s audit is available to a doctor key (its own sessions) and to an institutional key. The audit list and the configurations require an institutional key.

​
A session’s audit

GET /v1/scribe-sessions/{id}/audit returns the audit for one session. The {id} is either the consultationInternalId you set, or the session id (ss_...) the API returns. Returns 404 when the session has no audit — audit is disabled for it, or has not run yet.
Response:
score is the weighted total on a 0..1 scale. Map it to a grade band with the rubric’s scoreBands, described in the audit configurations section below.

​
Listing audits

GET /v1/audits lists your institution’s audits, most recent first. It requires an institutional API key; a doctor key returns 403. Paginate with page (1-based) and limit (1–50, default 20). Filter with reviewStatus, createdFrom, and createdTo.
Response:
total and totalPages are always null — the list is not counted server-side. Use hasMore to paginate. Each item omits the per-section breakdown; fetch the full audit from the session endpoint above.

​
Audit configurations

GET /v1/audits/configurations returns the rubrics assigned to your institution — the ones used to audit it. It requires an institutional API key. Each rubric lists its weighted sections and its grade scoreBands, so you can turn a score into a label.
Response:
A score earns the first band whose threshold is at or below it (bands are sorted by threshold, descending). label and displayName may be null when the rubric carries no default-locale text.