REST ClientCalling

live_transcribe

View as MarkdownOpen in Claude

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 instead.

Request

idstringRequiredformat: "uuid"
The unique identifying ID of an existing call.
paramsobjectRequired
An object of parameters that will be utilized by the active command.

Response

Call LegobjectRequired
Returned when the call is a standard PSTN, SIP, or WebRTC call.
OR
Fabric Subscriber Device LegobjectRequired

Returned when the call is a Fabric subscriber device leg. The status field is always null for this type.

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9client.calling.live_transcribe(
10    call_id="call-id-xxx",
11    action={
12        "start": {
13            "lang": "en-US",
14            "direction": ["local-caller", "remote-caller"],
15            "webhook": "https://example.com/transcription-events",
16            "live_events": True,
17        }
18    },
19)