Output Schemas
GET
/v1/orgs/{org_id}/schemas/{schema_id}Get Schema
Get a single output schema.
Runtime, CI or Admin tokenscope: readoperation_id: schemas.get
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 | — |
| schema_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
idrequiredstring
namerequiredstring
versionrequiredinteger
json_schemarequiredobject
descriptionstring | null
example_outputstring | null
is_activeboolean
created_atstring | null
updated_atstring | null
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/schemas/00000000-0000-0000-0000-000000000000' \ -H 'Authorization: Bearer $ZNYX_TOKEN'
Response
application/json
Successful Response
{
"id": "string",
"name": "string",
"version": 0,
"json_schema": {},
"description": null,
"example_output": null,
"is_active": false,
"created_at": null,
"updated_at": null
}Schema: object