REST API HTTP reference

This is the wire-level reference for the CALIBER management API. It is not the Python SDK reference: it names the HTTP routes, their common operations, and where to fetch the machine-readable contract.

Management API root#

All management routes are mounted under:

/ajax-api/2.0/mlflow/caliber

The served management OpenAPI document lives at:

GET /ajax-api/2.0/mlflow/caliber/openapi.json

Core discovery routes#

Representative resource families#

Workflow-service OpenAPI#

Published workflow services have a second OpenAPI surface:

GET /ajax-api/2.0/mlflow/caliber/services/{workflow_id}/openapi.json

That document is about the externally invocable service for one workflow, not the CALIBER management API itself.

Shared contract building blocks#

These pieces come directly from the served management OpenAPI document and apply across the whole management API, independent of any one route family.

Security and scoping schemes#

Shared JSON shapes#

Shared response components#

SDK coverage by route family#

Use the typed SDK where it exists. When a family is marked Raw only, the current supported fallback is client.raw or an HTTP client generated from the served OpenAPI document.

Current route inventory#

This inventory is generated at build time from the live CALIBER route table and the same OpenAPI builder that serves GET /ajax-api/2.0/mlflow/caliber/openapi.json. The served contract is route-table grounded and body-complete: paths and methods come from the live router, while request and success-response bodies are inferred from the handlers and the Pydantic models they already use.

Coverage summary#

Auth and scoping contract#

• Every route below requires an authenticated CALIBER caller.
• Browser-style writes additionally require X-CALIBER-CSRF when CSRF enforcement is enabled.
• Project-scoped automation can supply X-CALIBER-Project to select the active workspace.
• Internal routes are listed for completeness, not as a supported public SDK contract.

Jump by resource family#

Use these quick jumps when you already know the CALIBER subsystem and want the detailed route table directly.

GA routes index#

Beta routes index#

Internal routes index#

GA routes#

Supported management routes that belong to the stable public automation surface.

OpenAPI JSON (openapi.json)#

1 operation(s) across 1 route path(s).

Auth (auth)#

11 operation(s) across 9 route path(s).

CSRF (csrf)#

1 operation(s) across 1 route path(s).

Me (me)#

1 operation(s) across 1 route path(s).

Capabilities (capabilities)#

1 operation(s) across 1 route path(s).

Settings (settings)#

3 operation(s) across 2 route path(s).

Projects (projects)#

14 operation(s) across 9 route path(s).

Prompts (prompts)#

22 operation(s) across 18 route path(s).

Skills (skills)#

19 operation(s) across 16 route path(s).

Tools (tools)#

20 operation(s) across 16 route path(s).

Agents (agents)#

9 operation(s) across 6 route path(s).

Workflows (workflows)#

28 operation(s) across 20 route path(s).

Workflow Versions (workflow-versions)#

14 operation(s) across 13 route path(s).

Workflow Runs (workflow-runs)#

20 operation(s) across 19 route path(s).

Workflow Components (workflow-components)#

1 operation(s) across 1 route path(s).

Workflow Templates (workflow-templates)#

1 operation(s) across 1 route path(s).

Workflow Files (workflow-files)#

1 operation(s) across 1 route path(s).

Services (services)#

3 operation(s) across 3 route path(s).

Eval Datasets (eval-datasets)#

11 operation(s) across 8 route path(s).

Evaluations (evaluations)#

3 operation(s) across 2 route path(s).

Judges (judges)#

6 operation(s) across 4 route path(s).

Workflow Cron Preview (workflow-cron-preview)#

1 operation(s) across 1 route path(s).

Workflow Promotions (workflow-promotions)#

2 operation(s) across 2 route path(s).

Beta routes#

Supported but still moving route groups. Expect capability growth and narrower compatibility guarantees.

Knowledge Bases (knowledge-bases)#

14 operation(s) across 10 route path(s).

Knowledge (knowledge)#

2 operation(s) across 2 route path(s).

MCP Servers (mcp-servers)#

13 operation(s) across 10 route path(s).

OpenAPI Integrations (openapi-integrations)#

23 operation(s) across 20 route path(s).

Releases (releases)#

13 operation(s) across 12 route path(s).

Review Queues (review-queues)#

7 operation(s) across 5 route path(s).

Jobs (jobs)#

4 operation(s) across 4 route path(s).

Observability (observability)#

7 operation(s) across 7 route path(s).

Events (events)#

1 operation(s) across 1 route path(s).

Gateway (gateway)#

9 operation(s) across 7 route path(s).

Cookbooks (cookbooks)#

2 operation(s) across 2 route path(s).

Aria (aria)#

10 operation(s) across 8 route path(s).

Audit Log (audit-log)#

2 operation(s) across 2 route path(s).

Knowledge Base Versions (knowledge-base-versions)#

7 operation(s) across 7 route path(s).

Knowledge Runs (knowledge-runs)#

1 operation(s) across 1 route path(s).

Object Store (object-store)#

13 operation(s) across 10 route path(s).

Playground Runs (playground-runs)#

3 operation(s) across 2 route path(s).

Secrets (secrets)#

4 operation(s) across 3 route path(s).

Workflow Benchmark Reports (workflow-benchmark-reports)#

4 operation(s) across 2 route path(s).

Internal routes#

Published for route-table completeness, but not part of the supported SDK contract.

Assistant (assistant)#

29 operation(s) across 22 route path(s).

Dashboard (dashboard)#

1 operation(s) across 1 route path(s).

Gate Verdicts (gate-verdicts)#

2 operation(s) across 1 route path(s).

Health (health)#

1 operation(s) across 1 route path(s).

LLM Pricing (llm-pricing)#

4 operation(s) across 2 route path(s).

Memory (memory)#

4 operation(s) across 2 route path(s).

Metrics (metrics)#

1 operation(s) across 1 route path(s).

Readiness (readiness)#

1 operation(s) across 1 route path(s).

System (system)#

11 operation(s) across 11 route path(s).