API Capabilities
Everything you need to integrate clinical letter generation into your workflow.
Letter Generation
Submit transcripts and receive professionally formatted clinical letters. Supports consultation notes, procedure reports, and more.
Real-time Status
Track transcription and letter generation progress with webhooks or polling. Know exactly when letters are ready.
Secure by Design
Healthcare privacy safeguards with encrypted storage. API keys with granular scopes for access control.
Quick Start
1
Get your API key
Sign up for a Briefly. account and generate an API key from the dashboard under Settings > API Keys.
2
Make your first request
Terminal
curl -X GET "https://briefly.health/api/v1/letters" \
-H "Authorization: Bearer briefly_sk_your_key_here" \
-H "Content-Type: application/json"3
Explore the documentation
Learn about all available endpoints, request schemas, and best practices in our full documentation.
API Endpoints
All endpoints require API key authentication via Bearer token.
Letters
GET
/api/v1/lettersList lettersGET
/api/v1/letters/{id}Get letter detailsPOST
/api/v1/lettersCreate letter from transcriptPatients
GET
/api/v1/patientsSearch patientsGET
/api/v1/patients/{id}Get patient detailsPOST
/api/v1/patientsCreate patientRecordings
POST
/api/v1/recordingsSubmit recordingGET
/api/v1/recordings/{id}/statusCheck status