Returns one dataset of the caller's org by name, together with its live item…
Returns one dataset of the caller's org by name, together with its live item count — the one read that answers how big the set actually is.
GET /v1/eval/datasets/{name}
| Address | https://api.hanzo.ai/v1/eval/datasets/{name} |
| Method | GET |
| Operation | get_eval_datasets_by_name |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one dataset of the caller's org by name, together with its live item count — the one read that answers how big the set actually is.
A name this org does not have is 404, which is also what another tenant's dataset looks like from here. Requires a validated principal; 403 without one.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | Name is the dataset the URL names. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | datasetView | ok |
200 body — 7 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
createdAt | body | string | — | CreatedAt is when the name was first written, kept across later edits. |
description | body | string | — | Description is free text the org wrote about what this set measures. |
items | body | integer | — | Items is how many examples the set holds. |
metadata | body | object | — | Metadata is the free-form object stored with the set, echoed back verbatim. |
metadata.* | body | object | — | |
name | body | string | — | Name is the dataset's org-unique handle and the segment that addresses it. |
updatedAt | body | string | — | UpdatedAt is when the description or metadata last changed. |
Failure carries the platform error shape — see Errors.
Examples
hanzo evals datasets get <name>import { Configuration, EvalApi } from 'hanzoai';
const api = new EvalApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getEvalDatasetsByName({ name: 'name' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import EvalApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = EvalApi(client).get_eval_datasets_by_name(name='name')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.EvalAPI.GetEvalDatasetsByName(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, eval_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = eval_api::get_eval_datasets_by_name(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.EvalApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new EvalApi(client).getEvalDatasetsByName();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/eval/datasets/<name> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches eval through the evals tool, which names its 16 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_eval_datasets"
}
}
}'How is this guide?