API Reference

Every endpoint, with request and response schemas and a live “Try it” playground, is listed in the Endpoints section of this tab’s sidebar.

Basics

Base URL: https://api.healos.ai/ext-api/v1
Auth: send your key as X-API-Key: hlsk_... on every request — see Authentication.
Shape: success responses are { "data": ... }; list endpoints add a meta block. Errors are { "error": ... }. See Making Requests and Error Handling.

Resources

Resource	Description
Patients	Create, read, update, and delete patient records
Documents	Upload, list, and delete patient documents
Appointments	Manage appointments with scheduling, recurrence, and status
Notes	Read clinical notes with transcript, codes, and patient context — see the Clinical Notes guide for bulk export

The bulk export endpoint (GET /notes/export, with format=json|csv|ndjson) is documented in the Clinical Notes guide, not in the endpoint playground.

List patients

​API Reference

​Basics

​Resources

API Reference

Basics

Resources