OpenAI Json Schema Builder

OpenAI Schema Builder

Build JSON schemas for OpenAI JSON mode with strict type validation. This tool can be used to generate the schema for calling the OpenAI API REST endpoint without using the SDK.

Schema Name

Properties

Name

Type

Description

Enum Values

Name

Type

Description

Items

Name

Type

Description

Properties

Name

Type

Description

Name

Type

Description

Generated Schema

{
  "type": "json_schema",
  "json_schema": {
    "name": "schema_name",
    "strict": true,
    "schema": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "complaint",
            "order",
            "appointment"
          ],
          "description": "Return the type of the email that is one of: complaint, order, appointment"
        },
        "ordered_products": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "item_id": {
                "type": "string",
                "description": "The item id of the product"
              },
              "amount": {
                "type": "number",
                "description": "The amount of the product"
              }
            },
            "required": [
              "item_id",
              "amount"
            ],
            "additionalProperties": false
          },
          "description": "If the mail contains a order return the products and amount"
        }
      },
      "required": [
        "type",
        "ordered_products"
      ],
      "additionalProperties": false,
      "$schema": "http://json-schema.org/draft-07/schema#"
    }
  }
}

Sample Output

{
  "type": "complaint",
  "ordered_products": [
    {
      "item_id": "example_item_id",
      "amount": 16
    },
    {
      "item_id": "example_item_id",
      "amount": 11
    },
    {
      "item_id": "example_item_id",
      "amount": 58
    }
  ]
}

Optimized for Dark Mode

OpenAI Json Schema Builder

OpenAI Schema Builder