Skip to main content

Get Model

Page Outline

Retrieves the full detail record for a single model by its unique identifier.

Base Path: /api/v1/models

Method: GET

Path: /{model_id}

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

Path Parameters

ParameterTypeDescription
model_idstringUnique identifier of the model (e.g., mdl-7f3a19bc)

Behavior

  • Returns HTTP 404 Not Found if no model with the given ID exists in the caller's organization.
  • Returns HTTP 403 Forbidden if the caller lacks read access to the model (enforced by RBAC).
  • The config field includes the full training configuration, merged with any organization-level defaults.
  • The dataset sub-object is included only if a dataset is currently linked.
  • Audit logging is not triggered on individual model reads.

Response

Returns a full Model object.

{
"id": "mdl-7f3a19bc",
"name": "My Churn Predictor",
"description": "Binary classification model to predict customer churn.",
"model_type": "auto",
"task_type": "classification",
"status": "ready",
"version": 3,
"tags": ["churn", "production"],
"config": {
"target_column": "churned",
"feature_columns": ["age", "tenure", "monthly_spend"],
"algorithm": "xgboost"
},
"dataset": {
"id": "ds-abc123",
"name": "Customer Records Q1 2026",
"linked_at": "2026-03-10T09:00:00Z"
},
"metrics": {
"accuracy": 0.934,
"f1_score": 0.921
},
"created_at": "2026-03-13T11:00:00Z",
"updated_at": "2026-03-13T14:22:10Z",
"created_by": "user-001"
}