---
title: "Start a live consultation audio session"
method: POST
path: "/v1/scribe-sessions/live"
tags: ["Scribe Sessions"]
---

# Start a live consultation audio session

`POST /v1/scribe-sessions/live`

## Request

- Base URL: `https://scribe-api.telepatia.ai`
- URL: `https://scribe-api.telepatia.ai/v1/scribe-sessions/live`
- Auth: HTTP bearer

Create a consultation and receive a WebSocket URL to stream the audio to. Body is `application/json` with the same metadata as the batch endpoint (`consultation`, `template`, `patient`, `context`); the `audio` block is not accepted. Stream to `live.url` as described on that field, then finish through the webhook + document GET contract shared with the batch endpoint. Retrying with the same consultation id while recording returns the same session with a fresh URL; finished consultations return 409.

## Request body

- object: The consultation metadata: the multipart ``metadata`` part, or the JSON body.
  - `consultation` ConsultationInput, required: The caller's consultation reference.
    - `id` string, required: Your consultation id, the key for every follow-up GET and webhook.
    - `modality` 'IN_PERSON' | 'TELEMEDICINE', nullable
  - `template` TemplateInput, required: Template selection: an existing public id xor an inline structured template.
    - `id` string, nullable: Public id of an existing template, self-describing by prefix: `mrc_` (medicalRecordConfiguration) or `ssc_` (scribeSessionConfiguration).
    - `sections` object, nullable: Inline structured template keyed by section name (e.g. 'chiefComplaint'). Auto-persisted and deduplicated by content hash. Mutually exclusive with `id`.
  - `patient` PatientInput, required: An existing patient by public id xor the inline identity.
    - `id` string, nullable: Public id of an existing patient (sp_...). Mutually exclusive with the inline identity.
    - `name` string, nullable
    - `document` PatientDocument: The patient's identity document (same enums and rules as the rest of the API).
      - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CD' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IQ' | 'IE' | 'IR' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'CN' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'CG' | 'GM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'PS' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TH' | 'MK' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'TZ' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required: ISO 3166-1 alpha-2 country codes. Mirrors tanjiro's CountryCodes enum.
      - `type` 'CC' | 'TI' | 'CE' | 'RC' | 'PASSPORT' | 'RG' | 'CPF' | 'OTHER_DOC', required: Supported patient identification document types.
      - `value` string, required
  - `context` ContextInput: Free-text context that feeds record generation.
    - `notes` string, nullable
    - `pastMedicalHistory` string, nullable
  - `source` SourceInput: An external media source that streams the audio to us (live endpoint only). When present, the live endpoint returns a ``connector`` descriptor to hand to that provider's API instead of a WebSocket URL the caller streams to itself. ``type`` is the provider id, which must match an adapter registered on the audio backend; a new provider is one adapter there plus one value here.
    - `type` 'vonage_audio_connector', required: External audio-source provider id.

## Response `201`

Successful Response

- union
  - LiveScribeSessionResponse: 201 response: the batch envelope plus the streaming URL.
    - `consultation` ConsultationRef, required: Echo of the caller's consultation reference.
      - `id` string, required
    - `status` 'created': Always `created` on success. Stream the audio to `live.url`; completion then follows the batch contract described on `status` above.
    - `live` LiveSessionInfo, required: Where and until when the caller can stream the consultation audio.
      - `url` string, required: Opaque wss URL to stream the audio to. Connect, send binary audio frames (PCM 16 kHz mono s16le, or Ogg/WebM Opus), then send `{"type": "stop_recording", "data": {}}`. Reconnecting to the same URL resumes the session.
      - `expiresAt` string, required: ISO 8601 instant after which the URL's credential is no longer valid.
  - ConnectorScribeSessionResponse: 201 response when a `source` was given: the envelope plus a connector descriptor.
    - `consultation` ConsultationRef, required: Echo of the caller's consultation reference.
      - `id` string, required
    - `status` 'created': Always `created` on success. Hand `connector` to your media provider; completion then follows the batch contract described on `status` above.
    - `connector` ConnectorInfo, required: How an external media source should connect to stream the consultation audio. The fields map 1:1 onto the Vonage ``startAudioConnector.websocket`` object: ``uri`` → ``websocket.uri``, ``headers`` → ``websocket.headers`` (carries the short-lived Bearer token), ``audioRate`` → ``audioRate``. The provider opens the socket to ``uri``; this service never sees the audio.
      - `source` string, required
      - `uri` string, required: Opaque wss URL the provider streams to. PCM 16 kHz mono s16le.
      - `headers` object, required: Headers the provider must attach to the WebSocket handshake.
      - `audioRate` integer: Sample rate to request from the provider (Hz).
      - `expiresAt` string, required: ISO 8601 instant after which the credential in `headers` is invalid.

## Other responses

- `400`: Bad Request — invalid parameters, validation failures, or missing fields.
- `401`: Unauthorized — missing or invalid API key.
- `403`: Forbidden — the API key is not allowed to perform this operation.
- `404`: Not Found — the requested resource does not exist.
- `409`: Conflict — resource already exists or is in a conflicting state.
- `413`: Content Too Large
- `503`: Service Unavailable — an external dependency is down.

---

[API](https://skmtc.dev/telepatia/apis/scribe-public-api.md) - [All operations](https://skmtc.dev/telepatia/apis/scribe-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/telepatia/apis/scribe-public-api/revisions/be963942e472?raw)