Check Session Status

Retrieve information about a transcription session.

Endpoint

GET /api/v3/speech-to-text/session/{session_id}

Path Parameters

Parameter	Type	Description
session_id	string	Unique session identifier

Response Type

Returns a BaseResponse<Session> structure:

type BaseResponse<T> = {
  count: number;
  total_results: number;
  result: T;
};

Session Type

export type Session = {
  id?: number;
  duration: number;
  error: string;
  filename: string;
  media_type: string;
  media_url: string;
  session_id: string;
  integration_id?: number;
  language: string;
  language_key?: string;
  status?: string;
  last_modified?: string;
  date_upload?: string;
  date_finished?: string;
  date_retried?: string;
  wave_info_url?: string;
  keep_media?: boolean;
  diarization?: boolean;
  date_session_start?: string;
  session_mode?: 'decode' | 'align' | 'upload' | null;
  allow_magic_link_export?: boolean;
};

Status Values

Possible status values:

• queued
• processing
• completed
• failed
• dead_letter

Note: The status field is optional.

List Sessions Endpoint

GET /api/v3/speech-to-text/session

Query Parameters

Parameter	Type	Default
offset	number	0
limit	number	25
q	string	-
sort	string	-
direction	'asc' | 'desc'	-

Returns BaseResponse<Session[]>.

Shared Session Endpoint

GET /api/v3/speech-to-text/session/{session_id}/shared

Query Parameters

Parameter	Type	Description
token	string	Authentication token for shared access

Returns BaseResponse<Session>.

Next Steps

• Retrieve Document - Download transcript when processing is complete
• Batch Overview - Upload new files for transcription
• Update Document - Modify transcript content
• Export Document - Export in various formats