Get streaming transcription

Request description

When we make a streaming transcription request and we do not pass the callbackUrl as a parameter when opening the Web Socket, the way we can use to obtain the transcription is through this endpoint.

Endpoint: /api/v1/get-streaming-transcription/<sessionId>
Method: GET

Where:

• sessionId: Identifier of the streaming transcription session whose transcription we want to obtain. You must replace <sessionId> with the actual session ID.

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

To set the API version on a specific request, you can add a specific header named X-Invox-Medical-Api-Version with the value of the version you are targeting:

X-Invox-Medical-Api-Version: 2025-11-01

Responses

Correct response

{
  "transcription": [
    {
      "text": "mock text",
      "start": 0.01,
      "end": 1.05,
      "speakerId": "speaker-1",
      "speakerName": "Doctor"
    }
  ],
  "transcriptionStatus": "SUCCESS",
  "vttTranscription": "WEBVTT\n\n00:00:00.010 --> 00:00:01.050\n<v Doctor>mock text\n"
}

type GetStreamingTranscriptionResponseType = {
  transcriptionStatus: "SUCCESS" | "FAILED";
  errorMessage?: string;
  transcription?: ITranscriptionSegment[];
  vttTranscription?: string;
};

interface ITranscriptionSegment {
  speakerId: string;
  text: string;
  start: number;
  end: number;
  speakerName: string;
}

Wrong responses

type GetTranscriptionResponseType = {
  message: string;
  errorType?: string;
};

type GetTranscriptionResponseType = {
  message: string;
  errorType?: string;
};

{
  "message": "Transcription not found",
  "errorType": "transcriptionNotFound"
}