# Clinical Notes API

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

The Clinical Notes API transcribes a recording and generates a clinical note from the transcript. Synchronous generation returns the transcript and note in one HTTP response. You can also submit a recording URL as an asynchronous job and poll its status.

## Key features

-   Generates notes using SOAP, General Medicine, or General Behavioral Health templates
-   Accepts an HTTPS or S3 URI to a recording
-   Accepts a multipart file upload for synchronous generation
-   Returns a complete Markdown note and an ordered array of note sections
-   Returns the transcript alongside the note

## Templates

Choose a template for the note's structure. If you omit `template` or leave it empty, both synchronous generation and asynchronous jobs use `GENERAL_MEDICINE`.

| Template                    | Description                                                                               |
| --------------------------- | ----------------------------------------------------------------------------------------- |
| `SOAP`                      | Subjective, Objective, Assessment, and Plan sections.                                     |
| `GENERAL_MEDICINE`          | General medical encounter sections, including history, examination, assessment, and plan. |
| `GENERAL_BEHAVIORAL_HEALTH` | Behavioral health encounter sections, including a Mental Status Exam.                     |

## Generate a note

1. Provide a recording URL or upload a file, and select a template.
2. Send a synchronous generation request.
3. Read the transcript from `transcript.text_display`.
4. Use `clinical_notes.full_note` for the complete note, or `clinical_notes.sections` for individual sections.

For the endpoint, input fields, and response schema, see [Synchronous generation](/docs/ai-services/clinical-notes/generate/).

For URL-based job submission and status retrieval, see [Asynchronous jobs](/docs/ai-services/clinical-notes/jobs/).