Output Schemas
POST
/v1/orgs/{org_id}/schemas/{schema_id}/validateValidate Output
Dry-run validation of output text against a schema.
CI or Admin tokenscope: writeoperation_id: schemas.validate
Authentication
Requires a CI- or admin-level token. Runtime tokens are rejected for mutations.
SDK install
pip install znyx-sdknpm install @znyx/sdkPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
| org_id#path | string | required | — |
| schema_id#path | string | required | — |
Header parameters
| Name | Type | Required | Description |
|---|---|---|---|
| X-API-Key#header | string | null | optional | — |
| authorization#header | string | null | optional | — |
Request bodyrequired
| Field | Type | Required | Description |
|---|---|---|---|
| output_text | string | required | — |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |
Response schema
validrequiredboolean
errorsrequired
Errors & what triggers them
| Code | Trigger | Fix |
|---|---|---|
| 401 | Missing or expired Authorization header. | — |
| 403 | Token does not have the required role (admin / editor). | — |
| 404 | Target resource does not exist in this org. | — |
| 422 | Request body failed validation. | — |
Request
curl -X POST 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/schemas/00000000-0000-0000-0000-000000000000/validate' \
-H 'Authorization: Bearer $ZNYX_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"output_text": "string"
}'Response
application/json
Successful Response
{
"valid": false,
"errors": [
{
"path": "string",
"message": "string",
"expected": null,
"actual": null
}
]
}Schema: object