API Reference

Use this reference to inspect Polyaxon REST endpoints, authentication, path and query parameters, request bodies, and response schemas.

The pages in this section are generated from static/polyaxon_sdk.openapi.json and grouped by API area.

Public API

Polyaxon is open and meant to be extended via custom workflows and integrations. All Polyaxon data and features are available via the API.

/api/v1

https://cloud.polyaxon.com/api/v1

There are 3 different groups of APIs:

This page → Project-level APIs: manage operations, artifacts, model versions, and project configuration
Organization-level APIs: manage members, teams, service accounts, and permissions
Instance Management API: administer organizations on self-hosted installations

Authentication

Authenticate with the API using an API token passed via the Authorization header. Tokens can be created from the Polyaxon UI (user settings) or via the CLI.

curl -H "Authorization: token <your-token>" \
  https://cloud.polyaxon.com/api/v1/orgs/<org>/projects

Access via SDKs

The Polyaxon Python library and JS/TS SDK provide typed wrappers around the REST API.

from polyaxon.client import PolyaxonClient

client = PolyaxonClient()

# List operations in a project
runs = client.runs_v1.list_runs("owner", "project")

# Get a specific operation
run = client.runs_v1.get_run("owner", "project", "run_uuid")

# List model versions
models = client.project_model_v1.list_versions("owner", "project")

import { PolyaxonClient } from "@polyaxon/client";

const client = new PolyaxonClient();

// List operations in a project
const runs = await client.runsV1.listRuns("owner", "project");

// Get a specific operation
const run = await client.runsV1.getRun("owner", "project", "run_uuid");

API Resources

The API provides endpoints for managing all Polyaxon resources:

Operations — Create, list, get, stop, delete, and manage runs (jobs, services, DAGs, matrix)
Artifacts — Upload, download, and manage artifacts and lineage
Model Registry — Manage models, versions, and stages
Component Hub — Browse and manage reusable components
Projects — Create, configure, and manage projects
Organizations — Manage members, teams, and settings
Agents & Queues — Configure agents, queues, and presets
Searches & Dashboards — Manage saved searches and custom dashboards

See the full API Reference for details.

Alternatives

You can also access data via:

UI — Batch exports from the Polyaxon UI
CLI — Full CLI for managing Polyaxon resources from the terminal