OpenMetadata ML Models API
`Machine Learning Models` are algorithms trained on data to find patterns or make predictions.
`Machine Learning Models` are algorithms trained on data to find patterns or make predictions.
openapi: 3.0.1
info:
title: OpenMetadata APIs Agent Executions ML Models API
description: Common types and API definition for OpenMetadata
contact:
name: OpenMetadata
url: https://open-metadata.org
email: openmetadata-dev@googlegroups.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.13'
servers:
- url: /api
description: Current Host
- url: http://localhost:8585/api
description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: ML Models
description: '`Machine Learning Models` are algorithms trained on data to find patterns or make predictions.'
paths:
/v1/mlmodels/{id}/followers:
put:
tags:
- ML Models
summary: Add a follower
description: Add a user identified by `userId` as follower of this model
operationId: addFollower_8
parameters:
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
requestBody:
description: Id of the user to be added as follower
content:
application/json:
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: model for instance {id} is not found
/v1/mlmodels/bulk:
put:
tags:
- ML Models
summary: Bulk create or update ML models
description: Create or update multiple ML models in a single operation. Returns a BulkOperationResult with success/failure details for each ML model.
operationId: bulkCreateOrUpdateMlModels
parameters:
- name: async
in: query
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMlModel'
responses:
'200':
description: Bulk operation results
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResult'
'202':
description: Bulk operation accepted for async processing
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResult'
'400':
description: Bad request
/v1/mlmodels:
get:
tags:
- ML Models
summary: List ML models
description: Get a list of mlmodels, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
operationId: listMlModels
parameters:
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,dashboard,followers,tags,usageSummary,extension,domains,sourceHash
- name: service
in: query
description: Filter MlModels by service name
schema:
type: string
example: airflow
- name: limit
in: query
description: Limit the number models returned. (1 to 1000000, default = 10)
schema:
maximum: 1000000
minimum: 0
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of models before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of models after this cursor
schema:
type: string
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
responses:
'200':
description: List of models
content:
application/json:
schema:
$ref: '#/components/schemas/MlModelList'
put:
tags:
- ML Models
summary: Create or update an ML model
description: Create a new ML model, if it does not exist or update an existing model.
operationId: createOrUpdateMlModel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMlModel'
responses:
'200':
description: The model
content:
application/json:
schema:
$ref: '#/components/schemas/MlModel'
'400':
description: Bad request
post:
tags:
- ML Models
summary: Create an ML model
description: Create a new ML model.
operationId: createMlModel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMlModel'
responses:
'200':
description: ML Model
content:
application/json:
schema:
$ref: '#/components/schemas/MlModel'
'400':
description: Bad request
/v1/mlmodels/{id}:
get:
tags:
- ML Models
summary: Get an ML model by Id
description: Get an ML model by `Id`.
operationId: getMlModelByID
parameters:
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,dashboard,followers,tags,usageSummary,extension,domains,sourceHash
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The model
content:
application/json:
schema:
$ref: '#/components/schemas/MlModel'
'404':
description: Model for instance {id} is not found
delete:
tags:
- ML Models
summary: Delete an ML model by Id
description: Delete an ML model by `Id`.
operationId: deleteMlModel
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: model for instance {id} is not found
patch:
tags:
- ML Models
summary: Update an ML model
description: Update an existing ML model using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchMlModel_1
parameters:
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/mlmodels/name/{fqn}:
get:
tags:
- ML Models
summary: Get an ML model by fully qualified name
description: Get an ML model by fully qualified name.
operationId: getMlModelByFQN
parameters:
- name: fqn
in: path
description: Fully qualified name of ML Model
required: true
schema:
type: string
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,dashboard,followers,tags,usageSummary,extension,domains,sourceHash
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The model
content:
application/json:
schema:
$ref: '#/components/schemas/MlModel'
'404':
description: Model for instance {fqn} is not found
delete:
tags:
- ML Models
summary: Delete a ML model by fully qualified name
description: Delete an ML model by `fullyQualifiedName`.
operationId: deleteMlModelByFQN
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: fqn
in: path
description: Name of the ML Model
required: true
schema:
type: string
responses:
'200':
description: OK
'404':
description: model for instance {fqn} is not found
patch:
tags:
- ML Models
summary: Update an ML model by name.
description: Update an existing ML model using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchMlModel
parameters:
- name: fqn
in: path
description: Name of the ML Model
required: true
schema:
type: string
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/mlmodels/async/{id}:
delete:
tags:
- ML Models
summary: Asynchronously delete an ML model by Id
description: Asynchronously delete an ML model by `Id`.
operationId: deleteMlModelAsync
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: model for instance {id} is not found
/v1/mlmodels/{id}/followers/{userId}:
delete:
tags:
- ML Models
summary: Remove a follower
description: Remove the user identified `userId` as a follower of the model.
operationId: deleteFollower_11
parameters:
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
- name: userId
in: path
description: Id of the user being removed as follower
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
/v1/mlmodels/{id}/versions/{version}:
get:
tags:
- ML Models
summary: Get a version of the ML model
description: Get a version of the ML model by given `id`
operationId: getSpecificMlModelVersion
parameters:
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
- name: version
in: path
description: ML Model version number in the form `major`.`minor`
required: true
schema:
type: string
example: 0.1 or 1.1
responses:
'200':
description: MlModel
content:
application/json:
schema:
$ref: '#/components/schemas/MlModel'
'404':
description: ML Model for instance {id} and version {version} is not found
/v1/mlmodels/history:
get:
tags:
- ML Models
summary: List all entity versions within a time range
description: 'Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. '
operationId: listAllEntityVersionsByTimestamp_34
parameters:
- name: startTs
in: query
description: Start timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: endTs
in: query
description: End timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: limit
in: query
description: Limit the number of entity returned (1 to 1000000, default = 10)
schema:
maximum: 500
minimum: 1
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of entity versions before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of entity versions after this cursor
schema:
type: string
responses:
'200':
description: List of all versions
content:
application/json:
schema:
$ref: '#/components/schemas/ResultList'
/v1/mlmodels/{id}/versions:
get:
tags:
- ML Models
summary: List ML model versions
description: Get a list of all the versions of an ML Model identified by `id`
operationId: listAllMlModelVersion
parameters:
- name: id
in: path
description: Id of the ML Model
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of Ml Model versions
content:
application/json:
schema:
$ref: '#/components/schemas/EntityHistory'
/v1/mlmodels/restore:
put:
tags:
- ML Models
summary: Restore a soft deleted ML model
description: Restore a soft deleted ML Model.
operationId: restore_25
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreEntity'
responses:
'200':
description: 'Successfully restored the MlModel '
content:
application/json:
schema:
$ref: '#/components/schemas/MlModel'
/v1/mlmodels/{id}/vote:
put:
tags:
- ML Models
summary: Update Vote for a Entity
description: Update vote for a Entity
operationId: updateVoteForEntity_11
parameters:
- name: id
in: path
description: Id of the Entity
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoteRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: model for instance {id} is not found
components:
schemas:
TagLabelRecognizerMetadata:
required:
- recognizerId
- recognizerName
- score
type: object
properties:
recognizerId:
type: string
format: uuid
recognizerName:
type: string
score:
type: number
format: double
target:
type: string
enum:
- content
- column_name
patterns:
type: array
items:
$ref: '#/components/schemas/PatternMatch'
BulkOperationResult:
type: object
properties:
dryRun:
type: boolean
status:
type: string
enum:
- success
- failure
- aborted
- partialSuccess
- running
abortReason:
type: string
numberOfRowsProcessed:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
numberOfRowsPassed:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
numberOfRowsFailed:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
successRequest:
type: array
items:
$ref: '#/components/schemas/BulkResponse'
failedRequest:
type: array
items:
$ref: '#/components/schemas/BulkResponse'
ChangeSummaryMap:
type: object
AccessDetails:
required:
- timestamp
type: object
properties:
timestamp:
type: integer
format: int64
accessedBy:
$ref: '#/components/schemas/EntityReference'
accessedByAProcess:
type: string
FieldChange:
type: object
properties:
name:
type: string
oldValue:
type: object
newValue:
type: object
CoverImage:
type: object
properties:
url:
type: string
position:
type: string
RestoreEntity:
required:
- id
type: object
properties:
id:
type: string
format: uuid
MlHyperParameter:
type: object
properties:
name:
type: string
value:
type: string
description:
type: string
LifeCycle:
type: object
properties:
created:
$ref: '#/components/schemas/AccessDetails'
updated:
$ref: '#/components/schemas/AccessDetails'
accessed:
$ref: '#/components/schemas/AccessDetails'
EntityHistory:
required:
- entityType
- versions
type: object
properties:
entityType:
type: string
versions:
type: array
items:
type: object
AssetCertification:
required:
- appliedDate
- expiryDate
- tagLabel
type: object
properties:
tagLabel:
$ref: '#/components/schemas/TagLabel'
appliedDate:
type: integer
format: int64
expiryDate:
type: integer
format: int64
VoteRequest:
type: object
properties:
updatedVoteType:
type: string
enum:
- votedUp
- votedDown
- unVoted
ResultList:
required:
- data
type: object
properties:
data:
type: array
items:
type: object
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
MlFeatureSource:
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
dataType:
type: string
enum:
- integer
- number
- string
- array
- date
- timestamp
- object
- boolean
description:
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
dataSource:
$ref: '#/components/schemas/EntityReference'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
BulkResponse:
type: object
properties:
request:
type: object
message:
type: string
status:
type: integer
format: int32
Paging:
required:
- total
type: object
properties:
before:
type: string
after:
type: string
offset:
type: integer
format: int32
limit:
type: integer
format: int32
total:
type: integer
format: int32
CreateMlModel:
required:
- name
- service
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
displayName:
type: string
description:
type: string
algorithm:
type: string
mlFeatures:
type: array
items:
$ref: '#/components/schemas/MlFeature'
target:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
mlHyperParameters:
type: array
items:
$ref: '#/components/schemas/MlHyperParameter'
dashboard:
maxLength: 3072
minLength: 1
type: string
mlStore:
$ref: '#/components/schemas/MlStore'
server:
type: string
format: uri
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
service:
maxLength: 3072
minLength: 1
type: string
extension:
type: object
sourceUrl:
type: string
domains:
type: array
items:
type: string
dataProducts:
type: array
items:
type: string
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
sourceHash:
maxLength: 32
minLength: 1
type: string
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
JsonPatch:
type: object
ChangeDescription:
type: object
properties:
fieldsAdded:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsUpdated:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsDeleted:
type: array
items:
$ref: '#/components/schemas/FieldChange'
previousVersion:
type: number
format: double
changeSummary:
$ref: '#/components/schemas/ChangeSummaryMap'
MlStore:
type: object
properties:
storage:
type: string
imageRepository:
type: string
MlModel:
required:
- algorithm
- id
- name
- service
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
displayName:
type: string
description:
type: string
algorithm:
type: string
mlFeatures:
type: array
items:
$ref: '#/components/schemas/MlFeature'
mlHyperParameters:
type: array
items:
$ref: '#/components/schemas/MlHyperParameter'
target:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
dashboard:
$ref: '#/components/schemas/EntityReference'
mlStore:
$ref: '#/components/schemas/MlStore'
server:
type: string
format: uri
href:
type: string
format: uri
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
followers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
usageSummary:
$ref: '#/components/schemas/UsageDetails'
version:
type: number
format: double
updatedAt:
type: integer
format: int64
updatedBy:
type: string
impersonatedBy:
type: string
service:
$ref: '#/components/schemas/EntityReference'
serviceType:
type: string
enum:
- Mlflow
- Sklearn
- CustomMlModel
- SageMaker
- VertexAI
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
deleted:
type: boolean
extension:
type: object
sourceUrl:
type: string
domains:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataProducts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataContract:
$ref: '#/components/schemas/EntityReference'
votes:
$ref: '#/components/schemas/Votes'
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
certification:
$ref: '#/components/schemas/AssetCertification'
sourceHash:
maxLength: 32
minLength: 1
type: string
entityStatus:
type: string
enum:
- Draft
- In Review
- Approved
- Archived
- Deprecated
- Rejected
- Unprocessed
provider:
type: string
enum:
- system
- user
- automation
children:
type: array
items:
$ref: '#/components/schemas/EntityReference'
style:
$ref: '#/components/schemas/Style'
experts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
ChangeEvent:
required:
- entityId
- entityType
- eventType
- id
- timestamp
type: object
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- entityCreated
- entityUpdated
- entityFieldsChanged
- entityNoChange
- entitySoftDeleted
- entityDeleted
- entityRestored
- threadCreated
- threadUpdated
- postCreated
- postUpdated
- taskResolved
- taskClosed
- logicalTestCaseAdded
- suggestionCreated
- suggestionUpdated
- suggestionAccepted
- suggestionRejected
- suggestionDeleted
- userLogin
- userLogout
entityType:
type: string
entityId:
type: string
format: uuid
domains:
type: array
items:
type: string
format: uuid
entityFullyQualifiedName:
type: string
previousVersion:
type: number
format: double
currentVersion:
type: number
format: double
userName:
type: string
impersonatedBy:
type: string
timestamp:
type: integer
format: int64
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
entity:
type: object
UsageStats:
required:
- count
type: object
properties:
count:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
percentileRank:
type: number
format: double
MlModelList:
required:
- data
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/MlModel'
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
Style:
type: object
properties:
color:
type: string
iconURL:
type: string
coverImage:
$ref: '#/components/schemas/CoverImage'
MlFeature:
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
dataType:
type: string
enum:
- numerical
- categorical
description:
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
featureSources:
type: array
items:
$ref: '#/components/schemas/MlFeatureSource'
featureAlgorithm:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
Votes:
type: object
properties:
upVotes:
type: integer
format: int32
downVotes:
type: integer
format: int32
upVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
downVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
TagLabel:
required:
- labelType
- source
- state
- tagFQN
type: object
properties:
tagFQN:
type: string
name:
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-ml-models-api-openapi.yml