AIController

Validate structured content schema

Check if a schema is valid and can be used to extract data using AI

post/ai/structured-content/validate

Request

defaultobject nullable

Optionally provide a default value for when no value can be found.

descriptionstring nullable

Provide a description of the schema to help the AI understand the schema.

enumValuesstring[] nullable

When using type string and format enum pass a collection of enum values here.

exampleobject nullable

Pass example values to help the AI understand the schema.

formatstring nullable

Format for string types. Can be null, date-time or enum.

maxItemsinteger nullable

minItemsinteger nullable

maxLengthinteger nullable

minLengthinteger nullable

patternstring nullable

Regex pattern for STRING type

propertiesobject nullable

Properties of an OBJECT schema. These are key value pairs where the key is the property name and the value is the schema for that property.

propertyOrderingstring[] nullable

Pass an array of property names to specify the order of properties in the generated JSON object if required.

requiredstring[] nullable

Is field required

maxPropertiesinteger nullable

minPropertiesinteger nullable

maximumnumber nullable

minimumnumber nullable

nullableboolean nullable

titlestring nullable

Primitive JSON schema types with a fallback CUSTOM for unknown values.

No recorded changes to this operation across all 1 revision of this API.