API Reference
Hanzo Engine API
Hanzo Engine provides GPU cluster management, ML job orchestration,
Hanzo Engine provides GPU cluster management, ML job orchestration,
bearerAuth — HTTP bearerBearerAuth — HTTP bearer
All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.
curl -H "Authorization: Bearer $HANZO_API_KEY" https://engine.hanzo.ai
| Method | Endpoint | Description |
|---|
GET | /v1/engine/clusters | List GPU clusters |
POST | /v1/engine/clusters | Register GPU cluster |
GET | /v1/engine/clusters/{id} | Get cluster |
PUT | /v1/engine/clusters/{id} | Update cluster |
DELETE | /v1/engine/clusters/{id} | Deregister cluster |
GET | /v1/engine/clusters/{id}/nodes | List cluster nodes |
| Method | Endpoint | Description |
|---|
GET | /v1/engine/gpus | List available GPU types |
GET | /v1/engine/gpus/allocations | Get GPU allocations |
| Method | Endpoint | Description |
|---|
GET | /v1/engine/jobs | List jobs |
POST | /v1/engine/jobs | Submit job |
GET | /v1/engine/jobs/{id} | Get job |
DELETE | /v1/engine/jobs/{id} | Delete job |
POST | /v1/engine/jobs/{id}/cancel | Cancel job |
GET | /v1/engine/jobs/{id}/logs | Get job logs |
GET | /v1/engine/jobs/{id}/metrics | Get job metrics |
| Method | Endpoint | Description |
|---|
GET | /v1/engine/pipelines | List ML pipelines |
POST | /v1/engine/pipelines | Create ML pipeline |
GET | /v1/engine/pipelines/{id} | Get pipeline |
DELETE | /v1/engine/pipelines/{id} | Delete pipeline |
GET | /v1/engine/pipelines/{id}/runs | List pipeline runs |
POST | /v1/engine/pipelines/{id}/runs | Create pipeline run |
GET | /v1/engine/pipelines/{id}/runs/{run_id} | Get pipeline run |
| Method | Endpoint | Description |
|---|
GET | /v1/engine/ray/clusters | List Ray clusters |
POST | /v1/engine/ray/clusters | Create Ray cluster |
GET | /v1/engine/ray/clusters/{name} | Get Ray cluster |
DELETE | /v1/engine/ray/clusters/{name} | Delete Ray cluster |
PUT | /v1/engine/ray/clusters/{name}/scale | Scale Ray workers |
GET | /v1/engine/ray/clusters/{name}/dashboard | Get Ray dashboard URL |
GET | /v1/engine/ray/clusters/{name}/status | Get Ray cluster status |
| Method | Endpoint | Description |
|---|
GET | /v1/engine/serve/endpoints | List serving endpoints |
POST | /v1/engine/serve/endpoints | Create serving endpoint |
GET | /v1/engine/serve/endpoints/{name} | Get serving endpoint |
PUT | /v1/engine/serve/endpoints/{name} | Update serving endpoint |
DELETE | /v1/engine/serve/endpoints/{name} | Delete serving endpoint |
GET | /v1/engine/serve/endpoints/{name}/metrics | Get serving endpoint metrics |
Hanzo Engine API guide · All Hanzo APIs · OpenAPI spec
How is this guide?