For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
        • Applications
        • Calls
        • Conferences
        • Faxes
        • LAML Bins
        • Messages
        • Phone Numbers
        • Queues
        • Recordings
        • Tokens
        • Transcriptions
          • delete
          • get
          • list
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientCompatTranscriptions

get

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

list

Next
Built with

Retrieve a single transcription by SID.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this transcription.
SidstringRequiredformat: "uuid"
The unique identifier for the transcription.

Response

sidstringRequiredformat: "uuid"
The unique identifier for the transcription.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account that created this transcription.
api_versionstringRequired
The version of the SignalWire API.
recording_sidstringRequiredformat: "uuid"
The unique identifier for the recording that this transcription was created from.
date_createdstringRequired
The date, in RFC 2822 format, this transcription was created.
date_updatedstringRequired
The date, in RFC 2822 format, this transcription was updated.
durationintegerRequired>=0
The duration, in seconds, of the transcribed audio.
pricestring or nullRequired
The charge for the transcription. Null if cost has not been calculated.
price_unitstringRequired
The currency, in ISO 4217 format, for the price of the transcription.
statusstringRequired
The status of the transcription. Always 'completed' for transcriptions returned by the API.
transcription_textstring or nullRequired
The text content of the transcription. Null if transcription text is not available.
typestringRequired
The type of the transcription. Currently always an empty string.
uristringRequired
The URI of this resource, relative to the API base URL.

Response Example

Response
1{
2  "sid": "b3877c40-da60-4998-90ad-b792e98472tr",
3  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
4  "api_version": "2010-04-01",
5  "recording_sid": "b3877c40-da60-4998-90ad-b792e98472re",
6  "date_created": "Thu, 27 Sep 2018 02:00:00 +0000",
7  "date_updated": "Fri, 28 Sep 2018 03:00:00 +0000",
8  "duration": 60,
9  "price": "-0.00025",
10  "price_unit": "USD",
11  "status": "completed",
12  "transcription_text": "Hello, this is a test transcription.",
13  "type": "",
14  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions/b3877c40-da60-4998-90ad-b792e98472tr.json"
15}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8const transcription = await client.compat.transcriptions.get("TR...");