Get transcription status
Request description
When we make an asynchronous transcription request and we do not pass the callbackUrl as a request parameter, the way we can use to obtain the transcription is through the transcription generation status query.
Endpoint: /api/v1/get-transcription
Method: POST
Remember: you can see the URL to consume this API in the Introduction section.
Header
{
"Content-Type": "application/json",
"Authorization": "Bearer <accessToken>"
}
Authorization: We'll pass the token obtained during the authentication process. You can reuse the generated tokens, as they have a 2-hour lifespan. Review this page: Credentials
Payload
{
"requestId": "mock-requestId"
}
Payload structure
type GetTranscriptionStatusPayloadType = {
requestId: string, // Request Id associated to the transcription
}
Responses
Correct response
Successful request
Describe the characteristics of a satisfactory response
200
Response example:
{
"transcription": [
{
"text": "mock text",
"start": 0.01,
"end": 1.05
},
],
"transcriptionStatus": "COMPLETED",
}
type GetTranscriptionStatusResponseType = {
transcription: ITranscriptionSegment[],
processingStatus: "COMPLETED" | "PENDING" | "ERROR",
errorMessage?: string
}
type ITranscriptionSegment = {
start: number
end: number,
text: string
}
Wrong responses
Unauthorized request
Describes the response when the request is not authorized
401
Response body
type GenerateReportResponseType = {
messsage: string
}
Forbidden request
Describes the response when the API Key is not allowed to consume this service
403
Response body
type GenerateReportResponseType = {
messsage: string
errorType: string
}
BATCH-TRANSCRIBERequest not found
Describe the characteristics of a not found request
404
Response body
{
"message":"Transcription not found",
"errorType": "transcriptionNotFound"
}
Bad request
Describe the characteristics of a bad request
400
Response body
type GetTranscriptionStatusResponseType = {
messsage: string
errorType: GENERATE_PRESIGNURL_ERROR_TYPE
}
enum GENERATE_PRESIGNURL_ERROR_TYPE {
INVALID_REQUEST_BODY= 'invalidRequestBody'
INCONSISTENT_INPUT='inconsistentInput'
}