Skip to content
Last updated

Represents a reusable JSON schema definition for structured assistant outputs. JSON schemas enable assistants to return validated, type-safe responses in a specific format.

Properties

id string

Unique identifier for the JSON schema. Format: schema_ followed by alphanumeric characters.

name string

Human-readable name for the schema. Used for identification in lists and UI.

description string optional

Description of what this schema is used for and what data it represents.

schema_object object

The actual JSON schema definition following the JSON Schema specification. Defines the structure, types, and validation rules for the output.

organization_id string

The organization this schema belongs to.

created_by string

User ID of the person who created this schema.

is_active boolean

Whether this schema is active and available for use.

version integer

Version number of the schema. Increments with each update.

created_at integer

Unix timestamp (seconds) when the schema was created.

updated_at integer

Unix timestamp (seconds) when the schema was last modified.

Usage

JSON schemas are referenced by assistants to enable structured output mode. When an assistant has output_mode set to json_schema, it will validate its responses against the specified schemas.