Get note settings
curl --request GET \
--url https://api.healos.ai/ext-api/v1/settings/notes \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/settings/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/settings/notes"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"default_template_id": "77777777-0000-0000-0000-000000000001",
"model": "standard",
"transcript_language": "en",
"note_language": "en",
"preserve_markdown_formatting": true,
"include_prior_visit_by_default": true,
"physician_term": "Dr.",
"patient_term": "Patient",
"specialty": "Podiatry",
"cpt_restrict_to_specialty": true,
"include_signature_in_export": true
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}Settings
Get note settings
The Scribe settings notes are generated with for the clinician who owns this API key: default template, model, languages, terminology and specialty. Read-only. Requires the settings:read scope.
GET
/
settings
/
notes
Get note settings
curl --request GET \
--url https://api.healos.ai/ext-api/v1/settings/notes \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/settings/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/settings/notes"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"default_template_id": "77777777-0000-0000-0000-000000000001",
"model": "standard",
"transcript_language": "en",
"note_language": "en",
"preserve_markdown_formatting": true,
"include_prior_visit_by_default": true,
"physician_term": "Dr.",
"patient_term": "Patient",
"specialty": "Podiatry",
"cpt_restrict_to_specialty": true,
"include_signature_in_export": true
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}| Requirement | Detail |
|---|---|
| Scope | settings:read (rolling out: not yet on api.healos.ai) |
| Rate limit | About 60 requests per minute per API key (shared by all endpoints; approximate) |
| Cost | Free |
Safety
- Writes data: No
- Safe to retry: Yes
- Contacts an outside system: None
- Dry run: Not needed (read-only).
Was this page helpful?

