GET /v1/services/mlmodelServices/{id}

from metadata.sdk import configure
from metadata.sdk.entities import MlModelServices

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
svc = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9")
print(f"{svc.fullyQualifiedName}: {svc.serviceType}")

# Get by ID with fields
svc = MlModelServices.retrieve(
    "ca22d46e-81b9-4e48-85b5-0adc44980da9",
    fields=["owners", "tags"]
)

# Get by fully qualified name
svc = MlModelServices.retrieve_by_name("mlflow_svc")

# Get by name with fields
svc = MlModelServices.retrieve_by_name(
    "mlflow_svc",
    fields=["owners", "tags", "domains"]
)

import static org.openmetadata.sdk.fluent.MlModelServices.*;

// Get by ID
var svc = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9");

// Get by ID with fields
var svc = MlModelServices.retrieve(
    "ca22d46e-81b9-4e48-85b5-0adc44980da9",
    "owners,tags"
);

// Get by fully qualified name
var svc = MlModelServices.retrieveByName("mlflow_svc");

// Get by name with fields
var svc = MlModelServices.retrieveByName("mlflow_svc", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
  "name": "mlflow_svc",
  "fullyQualifiedName": "mlflow_svc",
  "serviceType": "Mlflow",
  "version": 0.1,
  "updatedAt": 1769982621618,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9",
  "connection": {
    "config": {
      "type": "Mlflow",
      "trackingUri": "http://localhost:8088",
      "registryUri": "http://localhost:8088",
      "supportsMetadataExtraction": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

GET

services

mlmodelServices

{id}

GET /v1/services/mlmodelServices/{id}

from metadata.sdk import configure
from metadata.sdk.entities import MlModelServices

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
svc = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9")
print(f"{svc.fullyQualifiedName}: {svc.serviceType}")

# Get by ID with fields
svc = MlModelServices.retrieve(
    "ca22d46e-81b9-4e48-85b5-0adc44980da9",
    fields=["owners", "tags"]
)

# Get by fully qualified name
svc = MlModelServices.retrieve_by_name("mlflow_svc")

# Get by name with fields
svc = MlModelServices.retrieve_by_name(
    "mlflow_svc",
    fields=["owners", "tags", "domains"]
)

import static org.openmetadata.sdk.fluent.MlModelServices.*;

// Get by ID
var svc = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9");

// Get by ID with fields
var svc = MlModelServices.retrieve(
    "ca22d46e-81b9-4e48-85b5-0adc44980da9",
    "owners,tags"
);

// Get by fully qualified name
var svc = MlModelServices.retrieveByName("mlflow_svc");

// Get by name with fields
var svc = MlModelServices.retrieveByName("mlflow_svc", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
  "name": "mlflow_svc",
  "fullyQualifiedName": "mlflow_svc",
  "serviceType": "Mlflow",
  "version": 0.1,
  "updatedAt": 1769982621618,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9",
  "connection": {
    "config": {
      "type": "Mlflow",
      "trackingUri": "http://localhost:8088",
      "registryUri": "http://localhost:8088",
      "supportsMetadataExtraction": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

Retrieve an ML Model Service

Get a single ML model service by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the ML model service to retrieve.

string

Comma-separated list of fields to include (e.g., owners,tags,domains).

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/services/mlmodelServices/name/{fqn} to retrieve by fully qualified name.

string

required

Fully qualified name of the ML model service (e.g., mlflow_svc).

string

Comma-separated list of fields to include: owners, tags, domains.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/services/mlmodelServices/{id}

from metadata.sdk import configure
from metadata.sdk.entities import MlModelServices

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
svc = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9")
print(f"{svc.fullyQualifiedName}: {svc.serviceType}")

# Get by ID with fields
svc = MlModelServices.retrieve(
    "ca22d46e-81b9-4e48-85b5-0adc44980da9",
    fields=["owners", "tags"]
)

# Get by fully qualified name
svc = MlModelServices.retrieve_by_name("mlflow_svc")

# Get by name with fields
svc = MlModelServices.retrieve_by_name(
    "mlflow_svc",
    fields=["owners", "tags", "domains"]
)

import static org.openmetadata.sdk.fluent.MlModelServices.*;

// Get by ID
var svc = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9");

// Get by ID with fields
var svc = MlModelServices.retrieve(
    "ca22d46e-81b9-4e48-85b5-0adc44980da9",
    "owners,tags"
);

// Get by fully qualified name
var svc = MlModelServices.retrieveByName("mlflow_svc");

// Get by name with fields
var svc = MlModelServices.retrieveByName("mlflow_svc", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
  "name": "mlflow_svc",
  "fullyQualifiedName": "mlflow_svc",
  "serviceType": "Mlflow",
  "version": 0.1,
  "updatedAt": 1769982621618,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9",
  "connection": {
    "config": {
      "type": "Mlflow",
      "trackingUri": "http://localhost:8088",
      "registryUri": "http://localhost:8088",
      "supportsMetadataExtraction": true
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

Returns

Returns an ML model service object with all requested fields populated.

Response

string

Unique identifier for the ML model service (UUID format).

string

ML model service name.

string

Fully qualified name of the service.

string

Human-readable display name.

string

Description of the ML model service in Markdown format.

string

Type of ML model service (e.g., Mlflow, Sklearn, SageMaker, CustomMlModel).

object

Connection configuration for the service.

Show properties

object

Service-specific connection configuration.

number

Version number for the entity.

array

List of owners. Only included when fields contains owners.

array

Classification tags. Only included when fields contains tags.

array

Domain assignments. Only included when fields contains domains.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this ML model service
`404`	`NOT_FOUND`	ML model service with given ID or FQN does not exist

List ML Model Services

Update an ML Model Service

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Retrieve an ML Model Service

Retrieve an ML Model Service

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling

​Retrieve an ML Model Service

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve an ML Model Service

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling