Suggest a schema from a description

Suggests a typed properties schema from a plain-language description of the data to store, using the org default LLM. Feed the result to the collection create endpoint.

POST /v1/suggest-schema

Suggest a schema from a description

cURL

curl --request POST \
  --url https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/suggest-schema \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "A CRM of companies with name, industry, website and annual revenue in EUR"
}
'

200

{
  "data": {
    "name": "<string>",
    "properties": {
      "product_name": {
        "type": "text"
      },
      "price": {
        "type": "double"
      },
      "stock": {
        "type": "integer",
        "nullable": true
      },
      "active": {
        "type": "boolean"
      },
      "released_at": {
        "type": "date"
      },
      "specs": {
        "type": "json"
      }
    },
    "model": "<string>"
  }
}

Authorizations

BearerAuthOrgApiKeyAuth

Authorization · string · header · required

User session JWT. Send as Authorization: Bearer <token>.

Body

application/json

description · string · required

Example:

"A CRM of companies with name, industry, website and annual revenue in EUR"

Response

200

application/json

Suggested schema.

data · object

Hide child attributes

data. name · string

data. properties · object

Column definitions: field name → type descriptor.

Hide child attributes

data.properties. {key} · object

Hide child attributes

data.properties.{key}. type · enum<string> · required

Available options: text, integer, double, boolean, date, datetime, json, array

data.properties.{key}. nullable · boolean

Example:

{
  "product_name": { "type": "text" },
  "price": { "type": "double" },
  "stock": { "type": "integer", "nullable": true },
  "active": { "type": "boolean" },
  "released_at": { "type": "date" },
  "specs": { "type": "json" }
}

data. model · string