Skip to main content

List Custom Models

Retrieve a paginated list of custom models.

Endpoint

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

Query Parameters

ParameterTypeDescription
offsetnumberPagination offset (default: 0)
limitnumberResults per page (default: 25)
qstringSearch query
sortstringSort field
directionstringSort direction: "asc" or "desc"

Response Type

type CustomModels = {
count: number;
total_results: number;
result: Model[];
};
type Model = {
id: number;
key: string;
name: string;
last_modified: string;
organization_id: number;
language_data: null;
is_trainable: boolean;
type: number;
base_language_id: number;
base_language_key: string;
training_log?: {
language_id: number;
training_status: number;
log_name: null;
};
};

Notes

  • Models are listed for the authenticated organization
  • Auto-refreshes every 20 seconds when actively viewing
  • Background refetching is enabled for real-time updates
  • Results are cached for 10 seconds (staleTime)
  • Search query filters models by name or other searchable fields
  • Sort and direction parameters allow custom ordering

See Data Models for complete schema reference.