Skip to main content
POST
/
v1
/
ambient
/
api
/
scribe
curl -sS https://rcm-api.athelas.com/v1/ambient/api/scribe \
  -H 'Authorization: Bearer $TOKEN' \
  -F 'audio_files=@/path/visit.mp3' \
  -F 'template_ids=1042' -F 'template_ids=2056'
{
  "scribe_id": 123,
  "status": "IN_PROGRESS",
  "submitted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
template_ids
integer[]
required

Required; repeat the form field for each template ID

​
audio_files
file[]

One or more audio files; Provide if not supplying transcripts;

Supported types: mp3, mp4, mpeg, mpga, m4a, wav, webm. Maximum file size in the web interface is 5MB. For files larger than 5MB, use the API directly via curl.

​
transcripts
string[]

One or more transcripts; Provide if not supplying audio;

​
patient_name
string
​
date_of_service
string<date-time>
​
additional_context
string

JSON-serialised metadata as a string

Example:

"{'age':72,'gender':'M'}"

Response

202 - application/json

Scribe creation response

​
scribe_id
integer
required
​
status
enum<string>
required
Available options:
IN_PROGRESS,
COMPLETED,
FAILED
​
submitted_at
string<date-time>
required