Transcription API
- NEW! - Interactive API docs, now live!
Visit api-docs.plumvoice.com to read Plum API documentation, build and test requests in our interactive API sandbox, review the responses, and share it all with your team.
Overview
Attention! Our queue transcription API method has reached its End of Life (EOL). Please use our AI-powered transcription method instead.
Review the following links for sample use cases of when a company might benefit from the Transcription API or detailed examples that explain how to call the Transcription API across Plum's product suite.
Plum offers two services for its Transcription REST API:
Method | Service | Description |
Please note that each of the Transcription REST APIs use HTTP AUTH for authentication. Please contact your account manager to get access credentials.
All of the Transcription REST APIs have the same return format that includes a status (success or failure), error message, and the result data.
Sample Responses
Transcription Status
GET
https://hosting.plumvoice.com/ws/transcription/{resource_type}/{transcription_id}
Returns the status of a transcription request.
Path Parameters
Name | Type | Description |
---|---|---|
resource_type | string |
|
transcription_id | string | Unique 128-bit hexidecimal identifier for this transcription request. Note: This value is provided in the result of a queued transcription request. |
Headers
Name | Type | Description |
---|---|---|
accept | string | application/json, application/xml |
Sample Code
Real-Time Transcription
POST
https://hosting.plumvoice.com/ws/transcription/{resource_type}
Performs real-time transcription of an audio file.
Path Parameters
Name | Type | Description |
---|---|---|
resource_type | string |
|
Headers
Name | Type | Description |
---|---|---|
accept | string | application/json, application/xml |
Request Body
Name | Type | Description |
---|---|---|
language | string | The language code the AI-engine should use. Note: Please see table below for all supported languages. |
audio | object | The audio file that will be transcribed. Note: Currently only headerless u-law audio is supported. |
Sample Code
Supported Language Codes
Language Code | Language | Country | |
de-DE | German | Germany | |
* | en-AU | English | Australia |
en-GB | English | United Kingdom | |
en-US | English | United States | |
es-ES | Spanish | Spain | |
* | es-MX | Spanish | Mexico |
* | es-US | Spanish | United States |
* | fr-CA | French | Canada |
fr-FR | French | France | |
ja-JP | Japanese | Japan | |
pt-BR | Portuguese | Brazil | |
zh-CN | Mandarin | China |
Note: Languages marked with an asterisk (*) are currently in Beta release and may not be ready for production use and are subject to change. They are initial offerings that are expected to improve in quality with time and usage.
Last updated