Custom Data Schemas allows you to create your own customized databases that both you and your AI Agent can interact with in order to perform its duties. They provide a key point of customization for your AI Agent.

Creating a new Custom Data Schema

Custom data schemas can be created by by going to the “Advanced” sub-menu of the “Configuration” menu.

You can then select “Create New Schema” in order to get started:

You should now see an empty form that allows you to configure your schema.

The first step is to assign your machine name. This fields gives a name for the schema that will be used to reference it, for example in URLs or in smart chain steps.

The machine name should be composed like a variable name would be in code. That means it should be lowercase and contain underscores instead of spaces. For example, if your data schema has the Title of “Sales Proposal”, then a good choice for the machine name would be sales_proposal.

The Title can be pretty much anything you want. But the Description field can be important because it will be provided to the AI if it ever needs to generate data in this format.

The key part of creating a data schema though is the Schema section which will be described next.

Adding Fields to your Schema

The Schema section is the key part of your custom data schema and will be where you spend most of your time. The Schema is defined using the JSON-schema standard, except with some additional fields and options that allow you to control the form of the data.

The root of your schema must always have "type": "object". Then, under the properties section is where you start to configure the actual properties of your schema. Here is an example of a section that you could put under properties:

        "brief": {
            "description": "A brief description of the project described in the proposal",
            "multiline": true,
            "rows": 4,
            "show_in_table_view": true,
            "table_view_order": 3,
            "title": "Brief",
            "type": "string"
        }

So if you put this into the properties section, the overall would look like this:

{
    "properties": {
        "brief": {
            "description": "A brief description of the project described in the proposal",
            "multiline": true,
            "rows": 4,
            "show_in_table_view": true,
            "table_view_order": 3,
            "title": "Brief",
            "type": "string"
        }
    },
    "type": "object"
}

You have now added a new field to your data schema!

Configuring Fields

Fields can have any of the following properties: