Note Generation
Generate structured clinical notes from conversation text or audio files.
Note generation is the core feature of the Scribeberry API. Provide conversation text (or an audio URL), choose a template, and receive a structured clinical note.
Generate from Text
The most common pattern: your application has already captured the conversation text (from a transcription service, chat interface, or manual entry) and you want to generate a structured note.
Response
Generate from Audio
Provide a URL to an audio file, and Scribeberry will transcribe it first, then generate the note.
ℹ️ Info: Audio note generation takes longer (30–120 seconds) because it includes transcription before note generation. The SDK automatically increases the timeout for this operation.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
templateId | string | ✅ | Template to structure the note with |
conversationText | string | Raw conversation text | |
audioUrl | string | URL to an audio file (WAV, MP3, WebM, etc.) | |
sourceLanguage | string | Language code (default: en-US) | |
transcriptionQuality | 'low' | 'medium' | 'high' | Transcription accuracy (default: high) | |
context | Record<string, string> | Additional context for the LLM |
⚠️ Warning: You must provide either
conversationTextoraudioUrl(or both). If both are provided, the conversation text is used as the primary input and the audio is transcribed as supplementary context.
Adding Context
Use the context parameter to provide additional information that should influence note generation:
Response Types
GenerateNoteResult
Note
The structured object makes it easy to extract individual sections:
External patient and encounter IDs
Pass optional context.patient_id and context.encounter_id on any note request. They are echoed on the response as context and included in webhook payloads when configured.
Regenerate one section
POST /api/v1/notes/regenerate-section with template_id, section_heading, and conversation_text. Optional current_section_content and instruction refine a single heading without rerunning the full note.
Idempotency
Send Idempotency-Key on POST /api/v1/notes to safely retry; identical keys within 24 hours return the cached response.
Best Practices
- Choose the right template — match the template to the visit type for best results
- Include context — additional context like patient age and specialty improves accuracy
- Use high quality transcription — for audio inputs,
highquality is recommended for clinical use - Validate output — always have a clinician review generated notes before use