Skip to main content

Registry Listing

Page Outline

Returns a registry-formatted listing of all published (promoted) model versions, intended for external consumers such as deployment pipelines, CI/CD systems, and the inference gateway.

Base Path: /api/v1/models

Method: GET

Path: /{model_id}/registry

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

Path Parameters

ParameterTypeDescription
model_idstringUnique identifier of the model

Query Parameters

ParameterTypeDefaultDescription
include_all_versionsbooleanfalseIf true, includes all versions, not just the promoted one
formatstringstandardResponse format: standard or mlflow (MLflow-compatible registry schema)

Behavior

  • By default, returns only the currently promoted version as the registry canonical entry.
  • The artifact_uri field provides a direct reference to the serialized model artifact in object storage.
  • The signature field describes the model's expected input schema and output schema for integration validation.
  • Returns HTTP 404 if the model is not found or no promoted version exists.

Response

Returns a RegistryEntry object.

{
"model_id": "mdl-7f3a19bc",
"model_name": "My Churn Predictor",
"promoted_version": {
"version_id": "ver-001",
"version_number": 3,
"algorithm": "xgboost",
"artifact_uri": "s3://rivergen-models/mdl-7f3a19bc/v3/model.pkl",
"promoted_at": "2026-03-13T16:10:00Z"
},
"signature": {
"inputs": [
{ "name": "age", "type": "long" },
{ "name": "tenure", "type": "long" },
{ "name": "monthly_spend", "type": "double" }
],
"outputs": [
{ "name": "prediction", "type": "string" },
{ "name": "probability", "type": "double" }
]
}
}