Skip to main content

Output Schemas

POST/v1/orgs/{org_id}/schemas/{schema_id}/validate

Validate 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/sdk

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired
schema_id#pathstringrequired

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional
authorization#headerstring | nulloptional

Request bodyrequired

FieldTypeRequiredDescription
output_textstringrequired

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

validrequiredboolean
errorsrequired

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.
403Token does not have the required role (admin / editor).
404Target resource does not exist in this org.
422Request 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