Skip to main content
GET
List models

Authorizations

Authorization
string
header
required

Static, non-expiring API key: Authorization: Bearer <FOURMINDS_API_KEY>.

Query Parameters

status
enum<string>

Return only models with this status. archived returns archived models, which are otherwise excluded.

Available options:
preparing,
training,
trained,
ready,
deleted,
error,
draft,
archived
search_text
string

Case-insensitive substring match on the model name.

is_shared
boolean

Filter by sharing. false returns only your own models that aren't shared. Omit to return all models.

use_case
enum<string>

Filter by domain (the model's fine_tune value). Case-insensitive. An unknown value returns an empty result.

Available options:
general,
finance,
marketing,
law,
manufacturing,
energy
sort_by
enum<string>

Sort field. When omitted, results are ordered by updated_at, newest first.

Available options:
name,
status,
created_at,
updated_at
sort_order
enum<string>
default:desc

Sort direction. Only applies when sort_by is set.

Available options:
asc,
desc
limit
integer

Maximum number of models to return. When set, the response is a paginated object instead of an array.

Required range: 1 <= x <= 500
offset
integer
default:0

Number of models to skip. Only applies when limit is set.

Required range: x >= 0

Response

Success. An array of models, or a paginated object when limit is set.

id
string
required

Numeric model ID, returned as a string.

Example:

"3801"

name
string
required
description
string | null
required
base_model_name
string
required
Example:

"GPT-OSS-120B"

trained_model_id
string
required
Example:

"0"

training_type_id
string
required
Examples:

"graph"

"sft"

dataset_id
integer | null
required
file_path
string
required
base_model_id
integer
required
personaId
integer | null
required
use_case_id
integer | null
required
use_case_name
string | null
required
use_case_label
string | null
required
use_case_description
string | null
required
use_case_custom
string | null
required
onboarding_goal
string | null
required
onboarding_role
string | null
required
has_image
boolean
required
trained_at
string<date-time>
required

Currently always the same as created_at.

status
string
required
Examples:

"ready"

"preparing"

"archived"

graph_status
string | null
required
Examples:

"ready"

"preparing"

graph_build_progress
integer | null
required

Knowledge-graph build progress. Usually 100 once the graph is ready, but some ready models report higher values (up to 1100 observed).

Required range: x >= 0
fine_tuning_status
boolean | null
required
metrics
object
required

Placeholder values. loss, trainingTime, epochsCompleted and parametersOptimized are the same for every model; accuracy and validationAccuracy are copies of success_rate.

dataset_info
object
required
external_model_id
integer | null
required
external_provider_type
string | null
required
external_model_capabilities
object | null
required
fine_tune
string
required

The model's domain.

Examples:

"general"

"finance"

category
string | null
required
Examples:

"General"

"Finance"

token_speed
number
required
response_time
number
required
success_rate
number
required
is_private
boolean | null
required
shared_with_organization
boolean | null
required
team_ids
string[] | null
required
team_names
string[] | null
required
owner_email
string | null
required

Filled in by List models; null from Get a model and Create a model.

is_shared
boolean
required
organization_name
string | null
required

Filled in by List models; null from Get a model and Create a model.

shared_user_count
integer
required
dataset_sharing_status
string | null
required
pending_dataset_access_requests
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
job_id
string | null
required