> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # liveTranscribe > Start live transcription with partial results on a call via REST. Start live transcription on an active call. Unlike standard transcription, live transcription streams partial results in real time as the caller speaks, enabling display of in-progress speech. For whole-call background transcription delivered after the call ends, see [`transcribe`](/docs/server-sdks/reference/typescript/rest/calling/transcribe) instead. ## **Request** ### Schema (`calling.live_transcribe`) ```yaml components: schemas: uuid: type: string format: uuid description: Universal Unique Identifier. title: uuid SWML.Calling.TranscribeDirection: type: string enum: - remote-caller - local-caller title: SWML.Calling.TranscribeDirection SpeechEngine: type: string enum: - deepgram - google description: Speech recognition engine options. title: SpeechEngine CallingLiveTranscribeStartActionStart: type: object properties: lang: type: string description: The language to transcribe (e.g., 'en-US', 'es-ES'). direction: type: array items: $ref: '#/components/schemas/SWML.Calling.TranscribeDirection' description: The direction(s) of the call to transcribe. webhook: type: string description: The webhook URL to receive transcription events. live_events: type: boolean description: Whether to send real-time utterance events as speech is recognized. ai_summary: type: boolean description: Whether to generate an AI summary when transcription ends. ai_summary_prompt: type: string description: >- The AI prompt that instructs how to summarize the conversation when `ai_summary` is enabled. speech_engine: $ref: '#/components/schemas/SpeechEngine' default: deepgram description: The speech recognition engine to use. speech_timeout: type: integer default: 60000 description: Speech timeout in milliseconds. vad_silence_ms: type: integer description: >- Voice activity detection silence time in milliseconds. Default depends on speech engine: `300` for Deepgram, `500` for Google. vad_thresh: type: integer default: 400 description: Voice activity detection threshold (0-1800). debug_level: type: integer default: 0 description: Debug level for logging (0-2). required: - lang - direction description: Starts live transcription of the call. title: CallingLiveTranscribeStartActionStart Calling.LiveTranscribeStartAction: type: object properties: start: $ref: '#/components/schemas/CallingLiveTranscribeStartActionStart' description: Starts live transcription of the call. required: - start description: Starts a live transcription session on the call. title: Calling.LiveTranscribeStartAction CallingLiveTranscribeSummarizeActionSummarize: type: object properties: webhook: type: string description: The webhook URL to receive the summary. prompt: type: string description: The AI prompt that instructs how to summarize the conversation. description: Request an on-demand AI summary of the conversation. title: CallingLiveTranscribeSummarizeActionSummarize Calling.LiveTranscribeSummarizeAction: type: object properties: summarize: $ref: '#/components/schemas/CallingLiveTranscribeSummarizeActionSummarize' description: Request an on-demand AI summary of the conversation. required: - summarize description: Requests an on-demand AI summary of the conversation transcribed so far. title: Calling.LiveTranscribeSummarizeAction Calling.LiveTranscribeStopAction: type: string enum: - stop description: Stops the live transcription session. title: Calling.LiveTranscribeStopAction CallingCallRequestDiscriminatorMappingCallingLiveTranscribeParamsAction: oneOf: - $ref: '#/components/schemas/Calling.LiveTranscribeStartAction' - $ref: '#/components/schemas/Calling.LiveTranscribeSummarizeAction' - $ref: '#/components/schemas/Calling.LiveTranscribeStopAction' description: 'The transcription action to perform: start, stop, or summarize.' title: CallingCallRequestDiscriminatorMappingCallingLiveTranscribeParamsAction CallingCallRequestDiscriminatorMappingCallingLiveTranscribeParams: type: object properties: action: $ref: >- #/components/schemas/CallingCallRequestDiscriminatorMappingCallingLiveTranscribeParamsAction description: 'The transcription action to perform: start, stop, or summarize.' required: - action description: An object of parameters that will be utilized by the active command. title: CallingCallRequestDiscriminatorMappingCallingLiveTranscribeParams Calling.CallLiveTranscribeRequest: type: object properties: id: $ref: '#/components/schemas/uuid' description: The unique identifying ID of an existing call. params: $ref: >- #/components/schemas/CallingCallRequestDiscriminatorMappingCallingLiveTranscribeParams description: An object of parameters that will be utilized by the active command. required: - id - params title: Calling.CallLiveTranscribeRequest ``` ## **Response** ### Schema (`Calling.CallResponse`) ```yaml components: schemas: uuid: type: string format: uuid description: Universal Unique Identifier. title: uuid Calling.CallDirection: type: string enum: - inbound - outbound - outbound-api description: The direction of the call. title: Calling.CallDirection CallingCallLegSource: type: string enum: - realtime_api description: Source of this call. title: CallingCallLegSource Calling.ChargeDetails: type: object properties: description: type: string description: Description for this charge. charge: type: number format: double description: Charged amount. required: - description - charge description: One itemized charge applied to the call. title: Calling.ChargeDetails Calling.CallResponseStatus: type: string enum: - queued - initiated - created - ringing - answered - ending - ended - failed - canceled - completed description: The status of the call throughout its lifecycle. title: Calling.CallResponseStatus CallingCallLegType0: type: string enum: - relay_pstn_call title: CallingCallLegType0 CallingCallLegType1: type: string enum: - relay_sip_call title: CallingCallLegType1 CallingCallLegType2: type: string enum: - relay_webrtc_call title: CallingCallLegType2 CallingCallLegType: oneOf: - $ref: '#/components/schemas/CallingCallLegType0' - $ref: '#/components/schemas/CallingCallLegType1' - $ref: '#/components/schemas/CallingCallLegType2' description: Type of this call. title: CallingCallLegType Calling.CallLeg: type: object properties: id: $ref: '#/components/schemas/uuid' description: >- The unique identifier of the call on SignalWire. This can be used to update the call programmatically. from: type: string description: The origin number or address. to: type: string description: The destination number or address. direction: $ref: '#/components/schemas/Calling.CallDirection' description: The direction of the call. source: $ref: '#/components/schemas/CallingCallLegSource' description: Source of this call. url: type: - string - 'null' description: The URL associated with this call. charge: type: number format: double description: Total charge for this call. created_at: type: string format: date-time description: The date and time when the call was created. charge_details: type: array items: $ref: '#/components/schemas/Calling.ChargeDetails' description: Details on charges associated with this call. status: oneOf: - $ref: '#/components/schemas/Calling.CallResponseStatus' - type: 'null' description: The status of the call. duration: type: - integer - 'null' description: The duration of the call in seconds. duration_ms: type: - integer - 'null' description: The duration of the call in milliseconds. billing_ms: type: - integer - 'null' description: The billable duration of the call in milliseconds. type: $ref: '#/components/schemas/CallingCallLegType' description: Type of this call. parent_id: oneOf: - $ref: '#/components/schemas/uuid' - type: 'null' description: The parent call ID if this is a child call. required: - id - from - to - direction - source - url - charge - created_at - charge_details - status - duration - duration_ms - billing_ms - type - parent_id description: Returned when the call is a standard PSTN, SIP, or WebRTC call. title: Calling.CallLeg CallingFabricDeviceLegSource: type: string enum: - realtime_api description: Source of this call. title: CallingFabricDeviceLegSource CallingFabricDeviceLegType: type: string enum: - fabric_subscriber_device_leg description: Type of this call. title: CallingFabricDeviceLegType Calling.FabricDeviceLeg: type: object properties: id: $ref: '#/components/schemas/uuid' description: >- The unique identifier of the call on SignalWire. This can be used to update the call programmatically. from: type: string description: The origin number or address. to: type: string description: The destination number or address. direction: $ref: '#/components/schemas/Calling.CallDirection' description: The direction of the call. source: $ref: '#/components/schemas/CallingFabricDeviceLegSource' description: Source of this call. url: type: - string - 'null' description: The URL associated with this call. charge: type: number format: double description: Total charge for this call. created_at: type: string format: date-time description: The date and time when the call was created. charge_details: type: array items: $ref: '#/components/schemas/Calling.ChargeDetails' description: Details on charges associated with this call. status: description: >- The status of the call. Always null for Fabric subscriber device legs. type: $ref: '#/components/schemas/CallingFabricDeviceLegType' description: Type of this call. required: - id - from - to - direction - source - url - charge - created_at - charge_details - status - type description: >- Returned when the call is a Fabric subscriber device leg. The `status` field is always null for this type. title: Calling.FabricDeviceLeg Calling.CallResponse: oneOf: - $ref: '#/components/schemas/Calling.CallLeg' - $ref: '#/components/schemas/Calling.FabricDeviceLeg' title: Calling.CallResponse ``` ## **Example** ```typescript {9} import { RestClient } from "@signalwire/sdk"; const client = new RestClient({ project: "your-project-id", token: "your-api-token", host: "your-space.signalwire.com" }); await client.calling.liveTranscribe("call-id-xxx", { start: { lang: "en-US", direction: ["local-caller", "remote-caller"], webhook: "https://example.com/transcription-events", live_events: true, }, }); ``` > Start live transcription with partial results on a call via REST.