API Reference

Auto Scribe

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Studies

Create a new study

POST/v1/autoScribe/studies

List studies with pagination

GET/v1/autoScribe/studies

Retrieve a study by ID

GET/v1/autoScribe/studies/{studyId}

Update a study

PATCH/v1/autoScribe/studies/{studyId}

Cancel a study

POST/v1/autoScribe/studies/cancel

Uncancel a study

POST/v1/autoScribe/studies/uncancel

Generate a reroute URL with viewer and dictation

POST/v1/autoScribe/studies/reroute-url

Generate a viewer-only reroute URL

POST/v1/autoScribe/studies/viewer-only-reroute-url

Retrieve a study by DICOM UID

GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}

ModelsExpand Collapse

PriorReport object { reportText, externalStudyId, modality, 2 more }

External prior report metadata and text stored on a study

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId: optional string

Integrator’s external study identifier

minLength1

maxLength256

modality: optional string

Imaging modality for the prior study

minLength1

maxLength100

studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1

maxLength1000

ReportIDWithStatus object { isCritical, reportId, status }

A report ID paired with its current status

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: ReportStatus

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

"in_progress"

"completed"

StudyCreateResponse object { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

dateOfBirth: optional string

Patient’s date of birth. Format: YYYY-MM-DD (e.g., ‘1990-05-20’)

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient’s height with unit (e.g., {value: 70, unit: ‘inches’} or {value: 178, unit: ‘cm’})

unit: HeightUnit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

procedure: optional string

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

sex: optional Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

"male"

"female"

"other"

studyDate: optional string

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

studyTime: optional string

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: optional object { unit, value }

Patient’s weight with unit (e.g., {value: 150, unit: ‘lbs’} or {value: 68, unit: ‘kg’})

unit: WeightUnit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

"lbs"

"kg"

value: number

minimum0

severity: Severity

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., ‘Brain MRI with Contrast’, ‘Chest CT’)

minLength1

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string

Timestamp when the study was last updated

formatdate-time

assignedTo: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

clinicalHistory: optional string

Relevant clinical history for the study

clinicalIndication: optional string

Clinical indication for the study

createdByApiKey: optional APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled }

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled: optional boolean

Whether this API key has a clinical-context enrichment webhook configured

isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

createdByUser: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

expressCustomer: optional ExpressCustomerReference { expressCustomerId, expressCustomerName }

A reference to an Express customer with basic identifying information

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId: optional string

Integrator-provided stable patient identifier for linking studies

externalReportId: optional string

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

isCritical: optional boolean

Whether the primary report was marked as critical at sign-off

metadata: optional map[string]

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

modality: optional string

Imaging modality for the study (free text)

priorReports: optional array of PriorReport { reportText, externalStudyId, modality, 2 more }

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId: optional string

Integrator’s external study identifier

minLength1

maxLength256

modality: optional string

Imaging modality for the prior study

minLength1

maxLength100

studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1

maxLength1000

reportIds: optional array of ReportIDWithStatus { isCritical, reportId, status }

Array of report IDs associated with this study, including addendums

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: ReportStatus

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

"in_progress"

"completed"

studyType: optional StudyType

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:

"standard"

"external"

technologistNotes: optional array of string

Technologist notes for the study

technologistTechnique: optional string

Imaging technique description

StudyListResponse object { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

dateOfBirth: optional string

Patient’s date of birth. Format: YYYY-MM-DD (e.g., ‘1990-05-20’)

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient’s height with unit (e.g., {value: 70, unit: ‘inches’} or {value: 178, unit: ‘cm’})

unit: HeightUnit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

procedure: optional string

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

sex: optional Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

"male"

"female"

"other"

studyDate: optional string

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

studyTime: optional string

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: optional object { unit, value }

Patient’s weight with unit (e.g., {value: 150, unit: ‘lbs’} or {value: 68, unit: ‘kg’})

unit: WeightUnit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

"lbs"

"kg"

value: number

minimum0

severity: Severity

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., ‘Brain MRI with Contrast’, ‘Chest CT’)

minLength1

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string

Timestamp when the study was last updated

formatdate-time

assignedTo: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

clinicalHistory: optional string

Relevant clinical history for the study

clinicalIndication: optional string

Clinical indication for the study

createdByApiKey: optional APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled }

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled: optional boolean

Whether this API key has a clinical-context enrichment webhook configured

isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

createdByUser: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

expressCustomer: optional ExpressCustomerReference { expressCustomerId, expressCustomerName }

A reference to an Express customer with basic identifying information

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId: optional string

Integrator-provided stable patient identifier for linking studies

externalReportId: optional string

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

isCritical: optional boolean

Whether the primary report was marked as critical at sign-off

metadata: optional map[string]

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

modality: optional string

Imaging modality for the study (free text)

priorReports: optional array of PriorReport { reportText, externalStudyId, modality, 2 more }

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId: optional string

Integrator’s external study identifier

minLength1

maxLength256

modality: optional string

Imaging modality for the prior study

minLength1

maxLength100

studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1

maxLength1000

reportIds: optional array of ReportIDWithStatus { isCritical, reportId, status }

Array of report IDs associated with this study, including addendums

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: ReportStatus

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

"in_progress"

"completed"

studyType: optional StudyType

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:

"standard"

"external"

technologistNotes: optional array of string

Technologist notes for the study

technologistTechnique: optional string

Imaging technique description

StudyRetrieveResponse object { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

dateOfBirth: optional string

Patient’s date of birth. Format: YYYY-MM-DD (e.g., ‘1990-05-20’)

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient’s height with unit (e.g., {value: 70, unit: ‘inches’} or {value: 178, unit: ‘cm’})

unit: HeightUnit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

procedure: optional string

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

sex: optional Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

"male"

"female"

"other"

studyDate: optional string

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

studyTime: optional string

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: optional object { unit, value }

Patient’s weight with unit (e.g., {value: 150, unit: ‘lbs’} or {value: 68, unit: ‘kg’})

unit: WeightUnit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

"lbs"

"kg"

value: number

minimum0

severity: Severity

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., ‘Brain MRI with Contrast’, ‘Chest CT’)

minLength1

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string

Timestamp when the study was last updated

formatdate-time

assignedTo: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

clinicalHistory: optional string

Relevant clinical history for the study

clinicalIndication: optional string

Clinical indication for the study

createdByApiKey: optional APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled }

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled: optional boolean

Whether this API key has a clinical-context enrichment webhook configured

isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

createdByUser: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

expressCustomer: optional ExpressCustomerReference { expressCustomerId, expressCustomerName }

A reference to an Express customer with basic identifying information

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId: optional string

Integrator-provided stable patient identifier for linking studies

externalReportId: optional string

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

isCritical: optional boolean

Whether the primary report was marked as critical at sign-off

metadata: optional map[string]

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

modality: optional string

Imaging modality for the study (free text)

priorReports: optional array of PriorReport { reportText, externalStudyId, modality, 2 more }

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId: optional string

Integrator’s external study identifier

minLength1

maxLength256

modality: optional string

Imaging modality for the prior study

minLength1

maxLength100

studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1

maxLength1000

reportIds: optional array of ReportIDWithStatus { isCritical, reportId, status }

Array of report IDs associated with this study, including addendums

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: ReportStatus

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

"in_progress"

"completed"

studyType: optional StudyType

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:

"standard"

"external"

technologistNotes: optional array of string

Technologist notes for the study

technologistTechnique: optional string

Imaging technique description

StudyUpdateResponse object { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

dateOfBirth: optional string

Patient’s date of birth. Format: YYYY-MM-DD (e.g., ‘1990-05-20’)

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient’s height with unit (e.g., {value: 70, unit: ‘inches’} or {value: 178, unit: ‘cm’})

unit: HeightUnit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

procedure: optional string

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

sex: optional Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

"male"

"female"

"other"

studyDate: optional string

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

studyTime: optional string

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: optional object { unit, value }

Patient’s weight with unit (e.g., {value: 150, unit: ‘lbs’} or {value: 68, unit: ‘kg’})

unit: WeightUnit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

"lbs"

"kg"

value: number

minimum0

severity: Severity

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., ‘Brain MRI with Contrast’, ‘Chest CT’)

minLength1

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string

Timestamp when the study was last updated

formatdate-time

assignedTo: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

clinicalHistory: optional string

Relevant clinical history for the study

clinicalIndication: optional string

Clinical indication for the study

createdByApiKey: optional APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled }

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled: optional boolean

Whether this API key has a clinical-context enrichment webhook configured

isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

createdByUser: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

expressCustomer: optional ExpressCustomerReference { expressCustomerId, expressCustomerName }

A reference to an Express customer with basic identifying information

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId: optional string

Integrator-provided stable patient identifier for linking studies

externalReportId: optional string

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

isCritical: optional boolean

Whether the primary report was marked as critical at sign-off

metadata: optional map[string]

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

modality: optional string

Imaging modality for the study (free text)

priorReports: optional array of PriorReport { reportText, externalStudyId, modality, 2 more }

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId: optional string

Integrator’s external study identifier

minLength1

maxLength256

modality: optional string

Imaging modality for the prior study

minLength1

maxLength100

studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1

maxLength1000

reportIds: optional array of ReportIDWithStatus { isCritical, reportId, status }

Array of report IDs associated with this study, including addendums

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: ReportStatus

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

"in_progress"

"completed"

studyType: optional StudyType

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:

"standard"

"external"

technologistNotes: optional array of string

Technologist notes for the study

technologistTechnique: optional string

Imaging technique description

StudyCancelResponse object { success, message }

Response for cancelling a study in AutoScribe

success: boolean

message: optional string

StudyUncancelResponse object { success, message }

Response for uncancelling a study in AutoScribe

success: boolean

message: optional string

StudyRerouteURLResponse object { url }

Response containing the generated reroute URL for AutoScribe (viewer + dictation)

url: string

StudyViewerOnlyRerouteURLResponse object { url }

Response containing the generated viewer-only reroute URL. Requires viewer to be configured.

url: string

StudyRetrieveByUidResponse object { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

dateOfBirth: optional string

Patient’s date of birth. Format: YYYY-MM-DD (e.g., ‘1990-05-20’)

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient’s height with unit (e.g., {value: 70, unit: ‘inches’} or {value: 178, unit: ‘cm’})

unit: HeightUnit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

procedure: optional string

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

sex: optional Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

"male"

"female"

"other"

studyDate: optional string

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

studyTime: optional string

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: optional object { unit, value }

Patient’s weight with unit (e.g., {value: 150, unit: ‘lbs’} or {value: 68, unit: ‘kg’})

unit: WeightUnit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

"lbs"

"kg"

value: number

minimum0

severity: Severity

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., ‘Brain MRI with Contrast’, ‘Chest CT’)

minLength1

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string

Timestamp when the study was last updated

formatdate-time

assignedTo: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

clinicalHistory: optional string

Relevant clinical history for the study

clinicalIndication: optional string

Clinical indication for the study

createdByApiKey: optional APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled }

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled: optional boolean

Whether this API key has a clinical-context enrichment webhook configured

isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

createdByUser: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

expressCustomer: optional ExpressCustomerReference { expressCustomerId, expressCustomerName }

A reference to an Express customer with basic identifying information

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId: optional string

Integrator-provided stable patient identifier for linking studies

externalReportId: optional string

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

isCritical: optional boolean

Whether the primary report was marked as critical at sign-off

metadata: optional map[string]

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

modality: optional string

Imaging modality for the study (free text)

priorReports: optional array of PriorReport { reportText, externalStudyId, modality, 2 more }

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId: optional string

Integrator’s external study identifier

minLength1

maxLength256

modality: optional string

Imaging modality for the prior study

minLength1

maxLength100

studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1

maxLength1000

reportIds: optional array of ReportIDWithStatus { isCritical, reportId, status }

Array of report IDs associated with this study, including addendums

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: ReportStatus

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

"in_progress"

"completed"

studyType: optional StudyType

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:

"standard"

"external"

technologistNotes: optional array of string

Technologist notes for the study

technologistTechnique: optional string

Imaging technique description

StudiesExternal

Create an external study

POST/v1/autoScribe/studies/external

Delete an external study

POST/v1/autoScribe/studies/external/delete

ModelsExpand Collapse

ExternalCreateResponse object { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

dateOfBirth: optional string

Patient’s date of birth. Format: YYYY-MM-DD (e.g., ‘1990-05-20’)

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient’s height with unit (e.g., {value: 70, unit: ‘inches’} or {value: 178, unit: ‘cm’})

unit: HeightUnit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

procedure: optional string

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

sex: optional Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

"male"

"female"

"other"

studyDate: optional string

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

studyTime: optional string

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: optional object { unit, value }

Patient’s weight with unit (e.g., {value: 150, unit: ‘lbs’} or {value: 68, unit: ‘kg’})

unit: WeightUnit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

"lbs"

"kg"

value: number

minimum0

severity: Severity

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., ‘Brain MRI with Contrast’, ‘Chest CT’)

minLength1

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string

Timestamp when the study was last updated

formatdate-time

assignedTo: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

clinicalHistory: optional string

Relevant clinical history for the study

clinicalIndication: optional string

Clinical indication for the study

createdByApiKey: optional APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled }

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled: optional boolean

Whether this API key has a clinical-context enrichment webhook configured

isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

createdByUser: optional UserReference { email, userId, firstName, 4 more }

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User’s first name

lastName: optional string

User’s last name

middleName: optional string

User’s middle name

suffix1: optional string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: optional string

Additional name suffix

expressCustomer: optional ExpressCustomerReference { expressCustomerId, expressCustomerName }

A reference to an Express customer with basic identifying information

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId: optional string

Integrator-provided stable patient identifier for linking studies

externalReportId: optional string

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

isCritical: optional boolean

Whether the primary report was marked as critical at sign-off

metadata: optional map[string]

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

modality: optional string

Imaging modality for the study (free text)

priorReports: optional array of PriorReport { reportText, externalStudyId, modality, 2 more }

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId: optional string

Integrator’s external study identifier

minLength1

maxLength256

modality: optional string

Imaging modality for the prior study

minLength1

maxLength100

studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1

maxLength1000

reportIds: optional array of ReportIDWithStatus { isCritical, reportId, status }

Array of report IDs associated with this study, including addendums

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: ReportStatus

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

"in_progress"

"completed"

studyType: optional StudyType

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:

"standard"

"external"

technologistNotes: optional array of string

Technologist notes for the study

technologistTechnique: optional string

Imaging technique description

ExternalDeleteResponse object { success, message }

Result of deleting an external study

success: boolean

message: optional string

StudiesExternalReports

Attach an external report

POST/v1/autoScribe/studies/external/reports

List external reports

GET/v1/autoScribe/studies/external/reports

Retrieve an external report

GET/v1/autoScribe/studies/external/reports/{externalReportId}

ModelsExpand Collapse

ReportCreateResponse object { externalReportId, studyId, studyInstanceUid }

Created or updated external report identifiers

externalReportId: string

studyId: string

studyInstanceUid: string

minLength1

ReportListResponse object { createdAt, externalReportId, hasReportText, 5 more }

createdAt: string

formatdate-time

externalReportId: string

hasReportText: boolean

reportPdfPresent: boolean

studyId: string

studyInstanceUid: string

minLength1

readerName: optional string

signedAt: optional string

ReportRetrieveResponse object { createdAt, externalReportId, studyId, 6 more }

External report snapshot including text and/or a presigned file URL

createdAt: string

formatdate-time

externalReportId: string

studyId: string

studyInstanceUid: string

minLength1

presignedUrl: optional string

Short-lived download URL for the attached PDF or image. Not used for AI tooling; the reader can still access it.

readerName: optional string

reportText: optional string

When this study is used as a prior, report AI tools leverage this text directly.

signedAt: optional string

snapshotMetadata: optional StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

dateOfBirth: optional string

Patient’s date of birth. Format: YYYY-MM-DD (e.g., ‘1990-05-20’)

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient’s height with unit (e.g., {value: 70, unit: ‘inches’} or {value: 178, unit: ‘cm’})

unit: HeightUnit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

procedure: optional string

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

sex: optional Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

"male"

"female"

"other"

studyDate: optional string

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

studyTime: optional string

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: optional object { unit, value }

Patient’s weight with unit (e.g., {value: 150, unit: ‘lbs’} or {value: 68, unit: ‘kg’})

unit: WeightUnit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

"lbs"

"kg"

value: number

minimum0