Sign in

v7

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-30132748.5 KB
Notes

Create a new clinical note

Creates a new note

post/v1/notes

Request body

transcriptstring required

The raw medical transcript text to be processed into a clinical note

datestring date required

Date of the patient encounter

language'en' | 'es' | 'fr' | 'de' | 'it' | 'pt' | 'ru' | 'zh'

Language code for the transcript content. While multiple languages are supported, English ('en') is recommended for optimal output quality and accuracy.

previousNotestring

Reference to a previous note if this is a follow-up. This field is optional.

contextstring nullable

Additional context for note generation. This field is optional.

instructionsstring[] nullable

Special instructions for note generation. This field is optional.

medicationListstring

List of up to 50 medications (comma separated) to use as reference for fixing spelling errors. This field is optional.

Example request

{
  "transcript": "Hey, how's it going? Good good yeah, so what's going on? Yeah, hi I'm Edward yeah hi hi Edward. How's it going? Yeah, good good. So I've been having a couple of issues like my back pain and knee pain.",
  "language": "en",
  "noteType": {
    "type": "note_style",
    "includeJson": true
  },
  "instructions": [
    "Use a professional and concise tone.",
    "Include key details without unnecessary elaboration.",
    "Ensure clarity for a general audience."
  ]
}

Response

Note response

statusstring

Status of the response

datestring date-time

Timestamp of the response

Example response

{
  "status": "ok",
  "data": {
    "noteId": "note_EXAMPLE123456789"
  },
  "date": "2024-11-07T21:24:51Z"
}