API Reference
Hanzo Console API
Hanzo Console is an LLM engineering platform for observability, prompt management,
Hanzo Console is an LLM engineering platform for observability, prompt management,
bearerAuth — HTTP bearerbasicAuth — HTTP basicBearerAuth — 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://console.hanzo.ai
| Method | Endpoint | Description |
|---|
GET | /v1/console/annotation-queues | Get all annotation queues |
POST | /v1/console/annotation-queues | Create an annotation queue |
GET | /v1/console/annotation-queues/{queueId} | Get an annotation queue |
GET | /v1/console/annotation-queues/{queueId}/items | Get items for an annotation queue |
| Method | Endpoint | Description |
|---|
GET | /v1/console/comments | Get all comments |
POST | /v1/console/comments | Create a comment |
GET | /v1/console/comments/{commentId} | Get a comment by ID |
| Method | Endpoint | Description |
|---|
GET | /v1/console/dataset-items | Get dataset items |
POST | /v1/console/dataset-items | Create or upsert a dataset item |
GET | /v1/console/dataset-items/{id} | Get a dataset item |
DELETE | /v1/console/dataset-items/{id} | Delete a dataset item |
| Method | Endpoint | Description |
|---|
POST | /v1/console/dataset-run-items | Create a dataset run item |
| Method | Endpoint | Description |
|---|
GET | /v1/console/datasets | Get all datasets |
POST | /v1/console/datasets | Create a dataset |
GET | /v1/console/datasets/{datasetName} | Get a dataset by name |
GET | /v1/console/datasets/{datasetName}/runs | Get dataset runs |
GET | /v1/console/datasets/{datasetName}/runs/{runName} | Get a dataset run and its items |
DELETE | /v1/console/datasets/{datasetName}/runs/{runName} | Delete a dataset run and all its run items |
| Method | Endpoint | Description |
|---|
GET | /v1/console/health | Check health of API and database |
| Method | Endpoint | Description |
|---|
POST | /v1/console/otel/v1/traces | Ingest OpenTelemetry traces |
POST | /v1/console/otel/v1/metrics | Ingest OpenTelemetry metrics |
| Method | Endpoint | Description |
|---|
POST | /v1/console/media | Get a presigned upload URL for a media record |
GET | /v1/console/media/{mediaId} | Get a media record |
PATCH | /v1/console/media/{mediaId} | Patch a media record (update upload status) |
| Method | Endpoint | Description |
|---|
GET | /v1/console/metrics | Get metrics from the project |
GET | /v1/console/metrics/daily | Get daily metrics |
| Method | Endpoint | Description |
|---|
GET | /v1/console/models | Get all models |
POST | /v1/console/models | Create a model definition |
GET | /v1/console/models/{id} | Get a model by ID |
DELETE | /v1/console/models/{id} | Delete a model |
| Method | Endpoint | Description |
|---|
GET | /v1/console/observations | Get a list of observations |
GET | /v1/console/observations/{observationId} | Get an observation by ID |
| Method | Endpoint | Description |
|---|
GET | /v1/console/projects/{projectId}/memberships | Get all memberships for a project |
PUT | /v1/console/projects/{projectId}/memberships | Create or update a project membership |
DELETE | /v1/console/projects/{projectId}/memberships | Delete a project membership |
GET | /v1/console/organizations/memberships | Get all memberships for the organization |
PUT | /v1/console/organizations/memberships | Create or update an organization membership |
DELETE | /v1/console/organizations/memberships | Delete an organization membership |
GET | /v1/console/organizations/projects | Get all projects for the organization |
GET | /v1/console/organizations/apiKeys | Get all API keys for the organization |
| Method | Endpoint | Description |
|---|
GET | /v1/console/projects | Get project associated with API key |
POST | /v1/console/projects | Create a new project (requires organization-scoped API key) |
GET | /v1/console/projects/{projectId} | Get a project by ID |
PUT | /v1/console/projects/{projectId} | Update a project |
DELETE | /v1/console/projects/{projectId} | Delete a project (async) |
GET | /v1/console/projects/{projectId}/apiKeys | Get all API keys for a project |
POST | /v1/console/projects/{projectId}/apiKeys | Create an API key for a project |
DELETE | /v1/console/projects/{projectId}/apiKeys/{apiKeyId} | Delete a project API key |
| Method | Endpoint | Description |
|---|
GET | /v1/console/prompts | Get a list of prompt names with versions and labels |
POST | /v1/console/prompts | Create a new prompt version |
GET | /v1/console/prompts/{promptName} | Get a prompt by name |
DELETE | /v1/console/prompts/{promptName} | Delete prompt versions |
GET | /v1/console/prompts/{promptName}/versions/{promptVersion} | Get a specific prompt version |
| Method | Endpoint | Description |
|---|
GET | /v1/console/score-configs | Get all score configs |
POST | /v1/console/score-configs | Create a score config |
GET | /v1/console/score-configs/{configId} | Get a score config |
PATCH | /v1/console/score-configs/{configId} | Update a score config |
| Method | Endpoint | Description |
|---|
GET | /v1/console/scores | Get all scores |
POST | /v1/console/scores | Create a score |
GET | /v1/console/scores/{scoreId} | Get a score by ID |
DELETE | /v1/console/scores/{scoreId} | Delete a score |
| Method | Endpoint | Description |
|---|
GET | /v1/console/sessions | Get sessions |
GET | /v1/console/sessions/{sessionId} | Get a session with its traces |
| Method | Endpoint | Description |
|---|
GET | /v1/console/traces | Get list of traces |
DELETE | /v1/console/traces | Delete multiple traces |
GET | /v1/console/traces/{traceId} | Get a specific trace with full details |
DELETE | /v1/console/traces/{traceId} | Delete a specific trace |
Hanzo Console API guide · All Hanzo APIs · OpenAPI spec
How is this guide?