Process the uploaded recording
curl --request POST \
--url https://rxnote.ai/api/v1/visits/{id}/process \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://rxnote.ai/api/v1/visits/{id}/process', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://rxnote.ai/api/v1/visits/{id}/process"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": 90211,
"patient_id": 123,
"status": "recording",
"language": "<string>",
"template_id": 123,
"outputs": [
"transcript"
],
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"icd_codes": {
"code_version": "icd11",
"generated_at": "<string>",
"codes": [
{
"code": "CA02",
"name": "Acute pharyngitis",
"confidence": "high"
}
]
},
"error": {
"code": "TRANSCRIPTION_FAILED",
"message": "<string>"
},
"upload": {
"url": "<string>",
"method": "PUT",
"headers": {
"Content-Type": "audio/webm"
},
"expires_at": "2023-11-07T05:31:56Z"
},
"transcript": {
"text": "<string>",
"duration_seconds": 123,
"segments": [
{
"speaker": 123,
"start_ms": 123,
"end_ms": 123,
"text": "<string>"
}
]
},
"note": {
"template": {
"id": 123,
"name": "<string>"
},
"framework": "soap",
"sections": [
{
"id": "<string>",
"title": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"text": "<string>"
}
]
}
],
"html": "<string>"
},
"summary": {}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}Visits
Process the uploaded recording
Call after the audio PUT succeeds — the API’s process-audio-background. Starts transcription and the note. Safe to repeat: a visit already processing or done is left alone. Scope visits:write.
POST
/
visits
/
{id}
/
process
Process the uploaded recording
curl --request POST \
--url https://rxnote.ai/api/v1/visits/{id}/process \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://rxnote.ai/api/v1/visits/{id}/process', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://rxnote.ai/api/v1/visits/{id}/process"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": 90211,
"patient_id": 123,
"status": "recording",
"language": "<string>",
"template_id": 123,
"outputs": [
"transcript"
],
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"icd_codes": {
"code_version": "icd11",
"generated_at": "<string>",
"codes": [
{
"code": "CA02",
"name": "Acute pharyngitis",
"confidence": "high"
}
]
},
"error": {
"code": "TRANSCRIPTION_FAILED",
"message": "<string>"
},
"upload": {
"url": "<string>",
"method": "PUT",
"headers": {
"Content-Type": "audio/webm"
},
"expires_at": "2023-11-07T05:31:56Z"
},
"transcript": {
"text": "<string>",
"duration_seconds": 123,
"segments": [
{
"speaker": 123,
"start_ms": 123,
"end_ms": 123,
"text": "<string>"
}
]
},
"note": {
"template": {
"id": 123,
"name": "<string>"
},
"framework": "soap",
"sections": [
{
"id": "<string>",
"title": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"text": "<string>"
}
]
}
],
"html": "<string>"
},
"summary": {}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"request_id": "req_Q2w9Lx7Hc4Vb8Np1Zs3Kt6"
}
}Authorizations
Your API key, created in RxNote under Settings → API: Authorization: Bearer rxn_live_….
Path Parameters
Example:
90211
Response
The visit, now processing.
Example:
90211
Available options:
recording, pending, processing, transcribing, generating-soap, completed, failed, no-speech Available options:
transcript, note, summary Set once POST /visits/{id}/icd-codes has run.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Only while the status is recording (waiting for the audio).
Show child attributes
Show child attributes
Omitted unless requested; null until ready.
Show child attributes
Show child attributes
Omitted unless requested; null until ready.
Show child attributes
Show child attributes
Omitted unless requested; null until ready.
Show child attributes
Show child attributes
