Create Schema

Create a new output schema (auto-increments version if name exists).

CI or Admin tokenscope: writeoperation_id: schemas.create

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

Name	Type	Required	Description
org_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
name	string	required	—
json_schema	object	required	—
description	string \| null	optional	—
example_output	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 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' \
  -H 'Authorization: Bearer $ZNYX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "json_schema": {},
  "description": null,
  "example_output": null
}'

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