> For the complete documentation index, see [llms.txt](https://docs.zenml.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zenml.io/api-reference/readme.md).

# Overview

The ZenML API provides programmatic access to ZenML services beyond what's available in the Python SDK.

Welcome to the ZenML API documentation. This guide provides information about both the open-source (OSS) and Pro API endpoints available in the ZenML platform.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>OSS API</strong></td><td>Open-source API endpoints for core ZenML functionality</td><td><a href="https://1923243478-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi7YEHe7o47cjJLXupcVm%2Fuploads%2Fgit-blob-60829a987732d7dfc433db2e827206ebd79fd267%2Foss-api.png?alt=media">oss-api.png</a></td><td><a href="/api-reference/oss-api/oss-api.md">OSS API</a></td></tr><tr><td><strong>Pro API</strong></td><td>Enhanced API endpoints for our pro features</td><td><a href="https://1923243478-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi7YEHe7o47cjJLXupcVm%2Fuploads%2Fgit-blob-12aaf2206b1c68d0fadce934ebfb59328e638ab3%2Fpro-api.png?alt=media">pro-api.png</a></td><td><a href="/api-reference/pro-api/pro-api.md">Pro API</a></td></tr></tbody></table>

## Use Cases

While the ZenML Python SDK covers most workflow requirements, the Server API offers additional utility for:

* Automated scaling of operations in production environments.
* Integration with external monitoring and logging systems.
* Programmatic management and audit of resources and configurations.
* Enterprise team management and access control (Pro).

By leveraging the ZenML API, users can enhance the robustness and control of their machine learning workflows, ensuring operations are both efficient and scalable.

<figure><img src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" alt="ZenML Scarf"><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zenml.io/api-reference/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
