Synchronous generation

Synchronous generation transcribes a recording and generates a note using the selected template. The HTTP response contains both results after processing completes.

Endpoint#

POST /aiservices/clinical_notes/generate

Authenticate with your Zoom AI Services credentials. The examples on this page send a token in the Authorization: Bearer header.

Input#

Provide a downloadable HTTPS or S3 URI in a JSON request, or upload a recording in the multipart file part.

Provide exactly one recording input. If transcription or note generation fails, the whole request fails.

Example request (cURL)#

This example uploads a recording and selects the SOAP template.

curl -X POST "https://api.zoom.us/v2/aiservices/clinical_notes/generate" \
  -H "Authorization: Bearer $TOKEN" \
  -F "file=@consultation.wav;type=audio/wav" \
  -F "template=SOAP"

For an HTTPS recording URL, send JSON instead:

curl -X POST "https://api.zoom.us/v2/aiservices/clinical_notes/generate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file": "https://example.com/consultation.wav",
    "template": "SOAP"
  }'

Output#

A successful request returns HTTP 200 and a JSON object with these fields.

clinical_notes is an object containing full_note and sections. Use the section array when your application displays headings and content separately.

The Clinical Notes transcript contains text_display. It does not return transcript segments.

Example response#

This response comes from a SOAP request using a synthetic clinical encounter. Generated content depends on the recording.

{
  "request_id": "bd89ab23-6e6c-439e-ab0f-19f07806b5a8",
  "transcript": {
    "text_display": "This is a fictional clinical encounter for API testing. The patient reports a mild headache since yesterday. The patient denies fever and nausea. No examination findings were recorded. The clinician plans a follow-up next week."
  },
  "clinical_notes": {
    "full_note": "**Subjective**\n\nPatient reports a mild headache since yesterday. They deny fever and nausea.\n\n**Objective**\n\nNo examination findings were recorded.\n\n**Assessment**\n\nMild headache since yesterday without reported fever or nausea. No explicit diagnosis beyond the reported symptom was documented.\n\n**Plan**\n\nFor mild headache, follow up next week.",
    "sections": [
      {
        "title": "Subjective",
        "content": "Patient reports a mild headache since yesterday. They deny fever and nausea."
      },
      {
        "title": "Objective",
        "content": "No examination findings were recorded."
      },
      {
        "title": "Assessment",
        "content": "Mild headache since yesterday without reported fever or nausea. No explicit diagnosis beyond the reported symptom was documented."
      },
      {
        "title": "Plan",
        "content": "For mild headache, follow up next week."
      }
    ]
  }
}

Unsupported media#

An input without a supported file extension returns HTTP 400 with reason set to UNSUPPORTED_MEDIA.

{
  "code": 400,
  "reason": "UNSUPPORTED_MEDIA",
  "message": "File extension \".jpg\" is not supported. Supported extensions: .m4a, .mp3, .mp4, .wav, .webm",
  "metadata": {}
}

Request errors#

If the request fails, the API returns one of these HTTP error codes.

Authentication errors#

Missing or invalid authentication returns HTTP 401. Authentication errors are separate from Clinical Notes application errors. See Get credentials for authentication requirements.