Skip to main content

Get Custom Model

Retrieve details about a specific custom model.

Endpoint

GET /api/v3/custom_models/{id}

Path Parameters

ParameterTypeRequiredDescription
idnumberYesModel ID

Response Type

type Models = {
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

  • Auto-refreshes every 20 seconds when actively viewing
  • Background refetching is enabled for real-time updates
  • Stale time is set to 10 seconds
  • Refetch on window focus is enabled
  • Returns error toast if model fetch fails
  • Model must belong to the authenticated user's organization

See Data Models for complete field reference.