> This page is for APIs.

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

# calling.transcribe

GET /

Start transcribing a call

Reference: https://signalwire.com/docs/apis/relay/server/calling/calling-transcribe

## AsyncAPI Specification

```yaml
asyncapi: 2.6.0
info:
  title: calling.transcribe
  version: subpackage_callingTranscribe.calling.transcribe
  description: Start transcribing a call
channels:
  /:
    description: Start transcribing a call
    publish:
      operationId: subpackage_callingTranscribe.calling.transcribe-publish
      summary: Server messages
      message:
        oneOf:
          - $ref: >-
              #/components/messages/subpackage_callingTranscribe.calling.transcribe-server-0-onCallingTranscribeCallTranscribeEvent
          - $ref: >-
              #/components/messages/subpackage_callingTranscribe.calling.transcribe-server-1-onCallingTranscribeResponse
    subscribe:
      operationId: subpackage_callingTranscribe.calling.transcribe-subscribe
      summary: calling.transcribe
      message:
        name: callingTranscribe
        title: calling.transcribe
        payload:
          $ref: '#/components/schemas/calling.transcribe_callingTranscribeRequest'
servers:
  production:
    url: wss://relay.signalwire.com/
    protocol: wss
    x-default: true
components:
  messages:
    subpackage_callingTranscribe.calling.transcribe-server-0-onCallingTranscribeCallTranscribeEvent:
      name: onCallingTranscribeCallTranscribeEvent
      title: calling.call.transcribe
      payload:
        $ref: '#/components/schemas/calling.transcribe_callTranscribeEvent'
    subpackage_callingTranscribe.calling.transcribe-server-1-onCallingTranscribeResponse:
      name: onCallingTranscribeResponse
      title: calling.transcribe response
      payload:
        $ref: '#/components/schemas/calling.transcribe_callingTranscribeResponse'
  schemas:
    ChannelsCallingTranscribeMessagesCallTranscribeEventJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingTranscribeMessagesCallTranscribeEventJsonrpc
    ChannelsCallingTranscribeMessagesCallTranscribeEventMethod:
      type: string
      enum:
        - signalwire.event
      description: Always `signalwire.event`.
      title: ChannelsCallingTranscribeMessagesCallTranscribeEventMethod
    ChannelsCallingTranscribeMessagesCallTranscribeEventParamsEventType:
      type: string
      enum:
        - calling.call.transcribe
      description: The event type — identifies which event this is.
      title: ChannelsCallingTranscribeMessagesCallTranscribeEventParamsEventType
    Calling.TranscribeState:
      type: string
      enum:
        - transcribing
        - finished
      title: Calling.TranscribeState
    Calling.CallTranscribeParams:
      type: object
      properties:
        node_id:
          type: string
          description: >-
            Opaque identifier that, paired with `call_id`, addresses this call.
            Echo back the value you received; treat it as opaque.
        call_id:
          type: string
          description: Unique identifier of the call.
        segment_id:
          type: string
          description: >-
            Identifier of the call segment this event belongs to, for
            correlating events within the same segment of a call.
        tag:
          type: string
          description: >-
            The `tag` you set when placing the call, echoed back so you can
            match the event to your request.
        control_id:
          type: string
          description: The `control_id` of the transcription this event belongs to.
        state:
          $ref: '#/components/schemas/Calling.TranscribeState'
          description: >-
            Whether transcription is still running (`transcribing`) or has
            stopped (`finished`).
        url:
          type: string
          description: >-
            Location of the recording captured alongside the transcription (for
            example, `recordings/<UUID>.wav`).
        recording_id:
          type: string
          description: The UUID of the recording captured alongside the transcription.
        status_url:
          type: string
          description: >-
            The callback URL you provided to receive transcription updates, if
            any.
        duration:
          type: number
          format: double
          description: >-
            Length of the recording in seconds. Present only when `state` is
            `finished`.
        size:
          type: integer
          format: int64
          description: >-
            Size of the recording in bytes. Present only when `state` is
            `finished`.
        start_time:
          type: number
          format: double
          description: >-
            Unix timestamp for when the recording started. Present only when
            `state` is `finished`.
        end_time:
          type: number
          format: double
          description: >-
            Unix timestamp for when the recording ended. Present only when
            `state` is `finished`.
      required:
        - node_id
        - call_id
        - control_id
        - state
      title: Calling.CallTranscribeParams
    ChannelsCallingTranscribeMessagesCallTranscribeEventParams:
      type: object
      properties:
        event_type:
          $ref: >-
            #/components/schemas/ChannelsCallingTranscribeMessagesCallTranscribeEventParamsEventType
          description: The event type — identifies which event this is.
        event_channel:
          type: string
          description: >-
            The channel the event was delivered on — for Calling events, the
            `protocol`

            string your connection received from `signalwire.connect`.
        timestamp:
          type: number
          format: double
          description: >-
            When the event was emitted, as a Unix timestamp in seconds. Always
            present.
        project_id:
          type: string
          description: >-
            Your project ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        space_id:
          type: string
          description: >-
            Your space ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        params:
          $ref: '#/components/schemas/Calling.CallTranscribeParams'
          description: The event-specific payload.
      required:
        - event_type
        - event_channel
        - timestamp
        - params
      description: The event envelope.
      title: ChannelsCallingTranscribeMessagesCallTranscribeEventParams
    calling.transcribe_callTranscribeEvent:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallingTranscribeMessagesCallTranscribeEventJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: >-
            Event id — a unique UUID generated for each event. Events are
            notifications: you do not reply to them.
        method:
          $ref: >-
            #/components/schemas/ChannelsCallingTranscribeMessagesCallTranscribeEventMethod
          description: Always `signalwire.event`.
        params:
          $ref: >-
            #/components/schemas/ChannelsCallingTranscribeMessagesCallTranscribeEventParams
          description: The event envelope.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        Fires when transcription starts and again when it stops. The `finished`
        event includes the recording's duration, size, and timestamps.
      title: calling.transcribe_callTranscribeEvent
    ChannelsCallingTranscribeMessagesCallingTranscribeResponseJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingTranscribeMessagesCallingTranscribeResponseJsonrpc
    Calling.TranscribeResult:
      type: object
      properties:
        code:
          type: string
          description: >-
            Result code as a string. `"200"` means success. Failures use an
            HTTP-style code

            such as `"400"` (bad request), `"403"`, `"404"` (call not found),
            `"405"`, `"409"`

            (conflict, for example another operation is still running), `"410"`
            (call gone),

            or `"500"`. If the call could not be reached in time, `code` is a
            lowercase error

            identifier instead, such as `response_timeout`, `not_available`, or

            `internal_error`.
        message:
          type: string
          description: >-
            Human-readable description of the result. On failure, it explains
            what went wrong. Always check `code`; `message` may be omitted when
            there is nothing extra to report.
        call_id:
          type: string
          description: The call this result is for, echoed from your request.
        control_id:
          type: string
          description: >-
            Your control identifier for the started action, echoed from your
            request.
        url:
          type: string
          description: >-
            Full storage URL of the audio recording captured for this
            transcription. Always a `.wav` file whose name is the recording's
            UUID.
      required:
        - code
      title: Calling.TranscribeResult
    JsonRpcErrorCode0:
      type: string
      enum:
        - '-32000'
      title: JsonRpcErrorCode0
    JsonRpcErrorCode1:
      type: string
      enum:
        - '-32001'
      title: JsonRpcErrorCode1
    JsonRpcErrorCode2:
      type: string
      enum:
        - '-32002'
      title: JsonRpcErrorCode2
    JsonRpcErrorCode3:
      type: string
      enum:
        - '-32003'
      title: JsonRpcErrorCode3
    JsonRpcErrorCode4:
      type: string
      enum:
        - '-32004'
      title: JsonRpcErrorCode4
    JsonRpcErrorCode5:
      type: string
      enum:
        - '-32005'
      title: JsonRpcErrorCode5
    JsonRpcErrorCode6:
      type: string
      enum:
        - '-32600'
      title: JsonRpcErrorCode6
    JsonRpcErrorCode7:
      type: string
      enum:
        - '-32601'
      title: JsonRpcErrorCode7
    JsonRpcErrorCode8:
      type: string
      enum:
        - '-32602'
      title: JsonRpcErrorCode8
    JsonRpcErrorCode9:
      type: string
      enum:
        - '-32603'
      title: JsonRpcErrorCode9
    JsonRpcErrorCode10:
      type: string
      enum:
        - '-32700'
      title: JsonRpcErrorCode10
    JsonRpcErrorCode:
      oneOf:
        - $ref: '#/components/schemas/JsonRpcErrorCode0'
        - $ref: '#/components/schemas/JsonRpcErrorCode1'
        - $ref: '#/components/schemas/JsonRpcErrorCode2'
        - $ref: '#/components/schemas/JsonRpcErrorCode3'
        - $ref: '#/components/schemas/JsonRpcErrorCode4'
        - $ref: '#/components/schemas/JsonRpcErrorCode5'
        - $ref: '#/components/schemas/JsonRpcErrorCode6'
        - $ref: '#/components/schemas/JsonRpcErrorCode7'
        - $ref: '#/components/schemas/JsonRpcErrorCode8'
        - $ref: '#/components/schemas/JsonRpcErrorCode9'
        - $ref: '#/components/schemas/JsonRpcErrorCode10'
      title: JsonRpcErrorCode
    JsonRpcError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/JsonRpcErrorCode'
          description: >-
            The error code — a negative integer identifying the failure. See
            `JsonRpcErrorCode` for the full list of values and meanings.
        message:
          type: string
          description: A human-readable description of what went wrong.
        original_request:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            An echo of the request that failed — the full JSON-RPC frame you
            sent

            (`jsonrpc`, `id`, `method`, `params`). Always present.
        requester_nodeid:
          type: string
          description: >-
            The node that sent the failed request. Present only on some routing
            errors.
        requester_identity:
          type: string
          description: >-
            The identity of the requester. Present only on some routing errors;
            same value as `requester_nodeid`.
        responder_nodeid:
          type: string
          description: >-
            The node that was handling the request. Present only on some routing
            errors.
        responder_identity:
          type: string
          description: >-
            The identity of the responder. Present only on some routing errors;
            same value as `responder_nodeid`.
        last_hop_timeout:
          type: boolean
          description: >-
            `true` when the request timed out on its final hop inside
            SignalWire. Present only on some timeout errors.
      required:
        - code
        - message
        - original_request
      description: >-
        A JSON-RPC 2.0 error object, delivered on the `error` field of a
        `JsonRpcResponse` when

        a request fails at the protocol level (bad version, authentication,
        scope, params, or

        your project's connection limit). It replaces `result` — a frame carries
        one or the other, never both.
      title: JsonRpcError
    calling.transcribe_callingTranscribeResponse:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallingTranscribeMessagesCallingTranscribeResponseJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: The id of the request this responds to.
        result:
          $ref: '#/components/schemas/Calling.TranscribeResult'
          description: The method result. Present when the request succeeded.
        error:
          $ref: '#/components/schemas/JsonRpcError'
          description: >-
            Present instead of `result` when the request failed at the protocol
            level.
      required:
        - jsonrpc
        - id
      description: >-
        A JSON-RPC response frame correlated to a request by `id`. On success
        the frame carries

        `result` (the method result). If the request fails at the protocol level
        — an

        incompatible version, failed authentication, insufficient scope, invalid
        params, or your

        project's connection limit — the frame carries `error` instead of
        `result`. Many

        method-level failures (for example most Calling failures) are reported
        the other way: a

        normal `result` whose own `code` is not `"200"`. Each method documents
        which form its

        failures take.


        An `error` returned for `signalwire.connect` is followed by the service
        closing the

        WebSocket; open a new connection to try again. The same happens when

        `signalwire.reauthenticate` sends credentials that are rejected, except
        for a

        Subscriber Access Token. Errors on any other request leave the
        connection open.
      title: calling.transcribe_callingTranscribeResponse
    ChannelsCallingTranscribeMessagesCallingTranscribeRequestJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingTranscribeMessagesCallingTranscribeRequestJsonrpc
    ChannelsCallingTranscribeMessagesCallingTranscribeRequestMethod:
      type: string
      enum:
        - calling.transcribe
      description: The name of the JSON-RPC method being invoked.
      title: ChannelsCallingTranscribeMessagesCallingTranscribeRequestMethod
    Calling.TranscribeParams:
      type: object
      properties:
        node_id:
          type: string
          description: >-
            Opaque identifier that, paired with `call_id`, addresses this call.
            Echo back the value you received; treat it as opaque.
        call_id:
          type: string
          description: Unique identifier of the call.
        control_id:
          type: string
          description: >-
            Your identifier for this transcription. Use the same `control_id`
            with `calling.transcribe.stop` to stop it.
        status_url:
          type: string
          format: uri
          description: >-
            An `http` or `https` URL where SignalWire POSTs the transcript text
            and transcription status updates as the transcription starts, runs,
            and ends.
      required:
        - node_id
        - call_id
        - control_id
      title: Calling.TranscribeParams
    calling.transcribe_callingTranscribeRequest:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallingTranscribeMessagesCallingTranscribeRequestJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: Request id, echoed on the correlated response.
        method:
          $ref: >-
            #/components/schemas/ChannelsCallingTranscribeMessagesCallingTranscribeRequestMethod
          description: The name of the JSON-RPC method being invoked.
        params:
          $ref: '#/components/schemas/Calling.TranscribeParams'
          description: The method's input parameters.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        A JSON-RPC request frame. `Method` is the method name; `Params` is the
        method's input.
      title: calling.transcribe_callingTranscribeRequest

```