Skip to main content

Get Model Settings

Page Outline

Retrieves display, notification, and access control settings for a specific model.

Base Path: /api/v1/models

Method: GET

Path: /{model_id}/settings

Auth: Requires a valid Bearer token (Authorization: Bearer <JWT>)

Path Parameters

ParameterTypeDescription
model_idstringUnique identifier of the model

Behavior

  • Settings are distinct from config — they control metadata display preferences, notification subscriptions, and access visibility, not training behavior.
  • Returns settings as last saved by any authorized user in the organization.
  • Returns HTTP 404 if the model is not found.
  • Audit logging is not triggered on settings reads.

Response

Returns a ModelSettings object.

{
"model_id": "mdl-7f3a19bc",
"display": {
"pinned_to_dashboard": true,
"color_label": "#4A90D9",
"icon": "brain"
},
"notifications": {
"on_training_complete": true,
"on_training_failure": true,
"on_drift_detected": false,
"notify_emails": ["alice@example.com", "bob@example.com"]
},
"access": {
"visibility": "org",
"allow_collaborator_invites": true
}
}