OpenMetadata LLM Services API
`LLM Service` is a service for Large Language Model providers such as OpenAI, Anthropic, Azure OpenAI, AWS Bedrock, Google Vertex AI, or custom LLM deployments.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openmetadata-llm-services-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: OpenMetadata APIs Agent Executions LLM Services 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: LLM Services
description: '`LLM Service` is a service for Large Language Model providers such as OpenAI, Anthropic, Azure OpenAI, AWS Bedrock, Google Vertex AI, or custom LLM deployments.'
paths:
/v1/services/llmServices/{id}/followers:
put:
tags:
- LLM Services
summary: Add a follower
description: Add a user identified by `userId` as follower of this LLM service
operationId: addFollowerToLLMService
parameters:
- name: id
in: path
description: Id of the LLM Service
required: true
schema:
type: string
format: uuid
requestBody:
description: Id of the user to be added as follower
content:
application/json:
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: LLM Service for instance {id} is not found
/v1/services/llmServices/{id}/testConnectionResult:
put:
tags:
- LLM Services
summary: Add test connection result
description: Add test connection result to the service.
operationId: addTestConnectionResult_4
parameters:
- name: id
in: path
description: Id of the service
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TestConnectionResult'
responses:
'200':
description: Successfully updated the service
content:
application/json:
schema:
$ref: '#/components/schemas/LLMService'
/v1/services/llmServices:
get:
tags:
- LLM Services
summary: List LLM services
description: Get a list of LLM services.
operationId: listLLMServices
parameters:
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: pipelines,owners,tags,domains,followers
- name: domain
in: query
description: Filter services by domain
schema:
type: string
example: AI
- name: limit
in: query
schema:
maximum: 1000000
minimum: 0
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of LLM services before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of LLM services 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 LLM service instances
content:
application/json:
schema:
$ref: '#/components/schemas/LLMServiceList'
put:
tags:
- LLM Services
summary: Update LLM service
description: Update an existing or create a new LLM service.
operationId: createOrUpdateLLMService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLLMService'
responses:
'200':
description: LLM service instance
content:
application/json:
schema:
$ref: '#/components/schemas/LLMService'
'400':
description: Bad request
post:
tags:
- LLM Services
summary: Create LLM service
description: Create a new LLM service.
operationId: createLLMService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLLMService'
responses:
'200':
description: LLM service instance
content:
application/json:
schema:
$ref: '#/components/schemas/LLMService'
'400':
description: Bad request
/v1/services/llmServices/name/{name}:
get:
tags:
- LLM Services
summary: Get LLM service by name
description: Get an LLM service by the service `name`.
operationId: getLLMServiceByFQN
parameters:
- name: name
in: path
description: Name of the LLM service
required: true
schema:
type: string
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: pipelines,owners,tags,domains,followers
- 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: LLM service instance
content:
application/json:
schema:
$ref: '#/components/schemas/LLMService'
'404':
description: LLM service for instance {name} is not found
delete:
tags:
- LLM Services
summary: Delete an LLM service by name
description: Delete an LLM service by `name`. If LLM models belong to the service, it can't be deleted.
operationId: deleteLLMServiceByName
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: name
in: path
description: Name of the LLM service
required: true
schema:
type: string
responses:
'200':
description: OK
'404':
description: LLMService for instance {name} is not found
/v1/services/llmServices/{id}:
get:
tags:
- LLM Services
summary: Get an LLM service
description: Get an LLM service by `Id`.
operationId: getLLMServiceByID
parameters:
- name: id
in: path
description: Id of the LLM service
required: true
schema:
type: string
format: uuid
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: pipelines,owners,tags,domains,followers
- 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: LLM service instance
content:
application/json:
schema:
$ref: '#/components/schemas/LLMService'
'404':
description: LLM service for instance {id} is not found
delete:
tags:
- LLM Services
summary: Delete an LLM service by Id
description: Delete an LLM service. If LLM models belong to the service, it can't be deleted.
operationId: deleteLLMService
parameters:
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the LLM service
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: LLMService for instance {id} is not found
patch:
tags:
- LLM Services
summary: Update an LLM service
description: Update an existing LLM service using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchLLMService_1
parameters:
- name: id
in: path
description: Id of the LLM service
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/services/llmServices/async/{id}:
delete:
tags:
- LLM Services
summary: Asynchronously delete an LLM service by Id
description: Asynchronously delete an LLM service. If LLM models belong to the service, it can't be deleted.
operationId: deleteLLMServiceAsync
parameters:
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the LLM service
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: LLM Service for instance {id} is not found
/v1/services/llmServices/{id}/followers/{userId}:
delete:
tags:
- LLM Services
summary: Remove a follower
description: Remove the user identified `userId` as a follower of the entity.
operationId: deleteFollower_19
parameters:
- name: id
in: path
description: Id of the Entity
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
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
/v1/services/llmServices/{id}/versions/{version}:
get:
tags:
- LLM Services
summary: Get a version of the LLM service
description: Get a version of the LLM service by given `Id`
operationId: getSpecificLLMServiceVersion
parameters:
- name: id
in: path
description: Id of the LLM service
required: true
schema:
type: string
format: uuid
- name: version
in: path
description: LLM service version number in the form `major`.`minor`
required: true
schema:
type: string
example: 0.1 or 1.1
responses:
'200':
description: LLM service
content:
application/json:
schema:
$ref: '#/components/schemas/LLMService'
'404':
description: LLM service for instance {id} and version {version} is not found
/v1/services/llmServices/history:
get:
tags:
- LLM Services
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_45
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/services/llmServices/{id}/versions:
get:
tags:
- LLM Services
summary: List LLM service versions
description: Get a list of all the versions of an LLM service identified by `Id`
operationId: listAllLLMServiceVersion
parameters:
- name: id
in: path
description: Id of the LLM service
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of LLM service versions
content:
application/json:
schema:
$ref: '#/components/schemas/EntityHistory'
/v1/services/llmServices/name/{fqn}:
patch:
tags:
- LLM Services
summary: Update an LLM service using name.
description: Update an existing LLM service using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchLLMService
parameters:
- name: fqn
in: path
description: Name of the LLM service
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/services/llmServices/restore:
put:
tags:
- LLM Services
summary: Restore a soft deleted LLM service
description: Restore a soft deleted LLM service.
operationId: restore_35
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreEntity'
responses:
'200':
description: Successfully restored the LLMService.
content:
application/json:
schema:
$ref: '#/components/schemas/LLMService'
components:
schemas:
EntityHistory:
required:
- entityType
- versions
type: object
properties:
entityType:
type: string
versions:
type: array
items:
type: object
AccessDetails:
required:
- timestamp
type: object
properties:
timestamp:
type: integer
format: int64
accessedBy:
$ref: '#/components/schemas/EntityReference'
accessedByAProcess:
type: string
LLMService:
required:
- id
- name
- serviceType
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
serviceType:
type: string
enum:
- OpenAI
- Anthropic
- AzureOpenAI
- Bedrock
- VertexAI
- Ollama
- HuggingFace
- CustomLLM
description:
type: string
displayName:
type: string
version:
type: number
format: double
updatedAt:
type: integer
format: int64
updatedBy:
type: string
models:
type: array
items:
$ref: '#/components/schemas/EntityReference'
pipelines:
type: array
items:
$ref: '#/components/schemas/EntityReference'
connection:
$ref: '#/components/schemas/LLMConnection'
testConnectionResult:
$ref: '#/components/schemas/TestConnectionResult'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
href:
type: string
format: uri
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
deleted:
type: boolean
dataProducts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataContract:
$ref: '#/components/schemas/EntityReference'
followers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
domains:
type: array
items:
$ref: '#/components/schemas/EntityReference'
ingestionRunner:
$ref: '#/components/schemas/EntityReference'
provider:
type: string
enum:
- system
- user
- automation
extension:
type: object
children:
type: array
items:
$ref: '#/components/schemas/EntityReference'
service:
$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'
impersonatedBy:
type: string
usageSummary:
$ref: '#/components/schemas/UsageDetails'
entityStatus:
type: string
enum:
- Draft
- In Review
- Approved
- Archived
- Deprecated
- Rejected
- Unprocessed
votes:
$ref: '#/components/schemas/Votes'
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
certification:
$ref: '#/components/schemas/AssetCertification'
UsageDetails:
required:
- dailyStats
- date
type: object
properties:
dailyStats:
$ref: '#/components/schemas/UsageStats'
weeklyStats:
$ref: '#/components/schemas/UsageStats'
monthlyStats:
$ref: '#/components/schemas/UsageStats'
date:
type: string
JsonPatch:
type: object
LLMServiceList:
required:
- data
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/LLMService'
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'
TestConnectionResult:
required:
- steps
type: object
properties:
lastUpdatedAt:
type: integer
format: int64
status:
type: string
enum:
- Successful
- Failed
- Running
steps:
type: array
items:
$ref: '#/components/schemas/TestConnectionStepResult'
AssetCertification:
required:
- appliedDate
- expiryDate
- tagLabel
type: object
properties:
tagLabel:
$ref: '#/components/schemas/TagLabel'
appliedDate:
type: integer
format: int64
expiryDate:
type: integer
format: int64
PatternMatch:
required:
- name
- score
type: object
properties:
name:
type: string
regex:
type: string
score:
type: number
format: double
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'
CreateLLMService:
required:
- name
- serviceType
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
displayName:
type: string
description:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
serviceType:
type: string
enum:
- OpenAI
- Anthropic
- AzureOpenAI
- Bedrock
- VertexAI
- Ollama
- HuggingFace
- CustomLLM
connection:
$ref: '#/components/schemas/LLMConnection'
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataProducts:
type: array
items:
type: string
domains:
type: array
items:
type: string
ingestionRunner:
$ref: '#/components/schemas/EntityReference'
extension:
type: object
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
UsageStats:
required:
- count
type: object
properties:
count:
minimum: 0
type: integer
format: int32
percentileRank:
type: number
format: double
TestConnectionStepResult:
required:
- mandatory
- name
- passed
type: object
properties:
name:
type: string
mandatory:
type: boolean
passed:
type: boolean
message:
type: string
errorLog:
type: string
Style:
type: object
properties:
color:
type: string
iconURL:
type: string
coverImage:
$ref: '#/components/schemas/CoverImage'
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'
LifeCycle:
type: object
properties:
created:
$ref: '#/components/schemas/AccessDetails'
updated:
$ref: '#/components/schemas/AccessDetails'
accessed:
$ref: '#/components/schemas/AccessDetails'
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
EntityReference:
required:
- id
- type
type: object
properties:
id:
type: string
format: uuid
type:
type: string
name:
type: string
fullyQualifiedName:
type: string
description:
type: string
displayName:
type: string
deleted:
type: boolean
inherited:
type: boolean
href:
type: string
format: uri
FieldChange:
type: object
properties:
name:
type: string
oldValue:
type: object
newValue:
type: object
ChangeSummaryMap:
type: object
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
LLMConnection:
type: object
properties:
config:
type: object
EntityError:
type: object
properties:
message:
type: string
entity:
type: object
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'
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'
RestoreEntity:
required:
- id
type: object
properties:
id:
type: string
format: uuid
CoverImage:
type: object
properties:
url:
type: string
position:
type: string
TagLabelMetadata:
type: object
properties:
recognizer:
$ref: '#/components/schemas/TagLabelRecognizerMetadata'
expiryDate:
type: integer
format: int64
TagLabel:
required:
- labelType
- source
- state
- tagFQN
type: object
properties:
tagFQN:
type: string
name:
type: string
displayName:
type: string
description:
type: string
style:
$ref: '#/components/schemas/Style'
source:
type: string
enum:
- Classification
- Glossary
labelType:
type: string
enum:
- Manual
- Propagated
- Automated
- Derived
- Generated
state:
type: string
enum:
- Suggested
- Confirmed
href:
type: string
format: uri
reason:
type: string
appliedAt:
type: string
format: date-time
appliedBy:
type: string
metadata:
$ref: '#/components/schemas/TagLabelMetadata'
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT