Get Transcription Task
curl --request GET \
--url https://platform-us.plaud.ai/developer/api/open/partner/ai/transcriptions/{transcription_id} \
--header 'X-Client-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'import requests
url = "https://platform-us.plaud.ai/developer/api/open/partner/ai/transcriptions/{transcription_id}"
headers = {
"X-Client-Id": "<api-key>",
"X-Client-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text){
"transcription_id": "task_exec_xxx",
"status": "SUCCESS",
"data": {
"text": "Meeting started at 10am...",
"language": "en",
"duration": 1843,
"results": [
{
"start": 0,
"end": 4.2,
"text": "Meeting started at 10am.",
"speaker_id": "Speaker 1",
"language": "en-US",
"language_probability": "0.941"
}
]
}
}Transcription API
Get Transcription Task
Retrieve the status and results of a transcription task. Keep polling while the status is PENDING, RECEIVED, STARTED, or PROGRESS. When the status is SUCCESS, the data object is populated.
GET
/
open
/
partner
/
ai
/
transcriptions
/
{transcription_id}
Get Transcription Task
curl --request GET \
--url https://platform-us.plaud.ai/developer/api/open/partner/ai/transcriptions/{transcription_id} \
--header 'X-Client-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>'import requests
url = "https://platform-us.plaud.ai/developer/api/open/partner/ai/transcriptions/{transcription_id}"
headers = {
"X-Client-Id": "<api-key>",
"X-Client-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text){
"transcription_id": "task_exec_xxx",
"status": "SUCCESS",
"data": {
"text": "Meeting started at 10am...",
"language": "en",
"duration": 1843,
"results": [
{
"start": 0,
"end": 4.2,
"text": "Meeting started at 10am.",
"speaker_id": "Speaker 1",
"language": "en-US",
"language_probability": "0.941"
}
]
}
} At this time, the Transcription API must be used with the Embedded SDK. After binding a device, the Transcription API is unlocked and you will be able to access your free ASR hours.
Authorizations
Your client_id, issued in the Portal.
Your api_key, issued alongside client_id / secret_key in the Portal.
Path Parameters
The transcription_id returned when the audio was submitted.
Response
200 - application/json
Transcription status and results
Example:
"task_exec_xxx"
PENDING, RECEIVED, STARTED, PROGRESS indicate the task is in progress — keep polling. SUCCESS means the data is ready. FAILURE and REVOKED are terminal failures.
Available options:
PENDING, RECEIVED, STARTED, PROGRESS, SUCCESS, FAILURE, REVOKED Example:
"PENDING"
Populated when the status is SUCCESS.
Show child attributes
Show child attributes
Was this page helpful?