Datasets
GET
/v1/orgs/{org_id}/datasets/{dataset_id}/samplesList Samples
List samples in a dataset.
Runtime, CI or Admin tokenscope: readoperation_id: datasets.listSamples
Authentication
Any bearer token belonging to the org can read this endpoint.
SDK install
pip install znyx-sdknpm install @znyx/sdkPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
| org_id#path | string | required | — |
| dataset_id#path | string | required | — |
Header parameters
| Name | Type | Required | Description |
|---|---|---|---|
| X-API-Key#header | string | null | optional | — |
| authorization#header | string | null | optional | — |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |
Response schema
totalrequiredinteger
limitrequiredinteger
offsetrequiredinteger
samplesrequired
Errors & what triggers them
| Code | Trigger | Fix |
|---|---|---|
| 401 | Missing or expired Authorization header. | — |
| 403 | Token does not have org access (wrong org_id, or insufficient role). | — |
| 404 | Resource does not exist in this org. | — |
Request
curl -X GET 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/datasets/00000000-0000-0000-0000-000000000000/samples' \ -H 'Authorization: Bearer $ZNYX_TOKEN'
Response
application/json
Successful Response
{
"total": 0,
"limit": 0,
"offset": 0,
"samples": [
{
"id": "string",
"input_text": "string",
"context": "string",
"expected_decision": null,
"expected_rule_hits": null,
"metadata": null,
"created_at": null
}
]
}Schema: object