Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZenML Models API

Registered models and their versions

ZenML Models API is one of 14 APIs that ZenML publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Models. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, a GitHub repository, and 5 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against a single base URL, https://your-zenml-server.example.com/api/v1.

3 operations 2 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Server
https://your-zenml-server.example.com/api/v1
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

ZenML Models API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Models 3

Registered models and their versions

GET
/models
List Models
listModels 2 params → 200
POST
/models
Create Model
createModel body → 201
GET
/model_versions
List Model Versions
listModelVersions 3 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Model (10 properties), ModelVersion (7 properties), ModelRequest (4 properties), Page (4 properties). Each schema is shown below with its type and property counts.

ModelVersionPage
Page
object
4 properties
ModelPage
Model
object
10 properties
ModelRequest
object
4 properties 1 required
ModelVersion
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenml-models-api-openapi.yml Raw ↑

Other APIs ZenML publishes across the network.

ZenML Pro REST API
ZenML Artifacts API
ZenML Auth API
ZenML Deployments API
ZenML Pipeline Runs API
ZenML Pipelines API
ZenML Projects API
ZenML Schedules API
ZenML Secrets API
ZenML Service Connectors API
ZenML Stack Components API
ZenML Stacks API