Suggest a schema from a description
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"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'A CRM of companies with name, industry, website and annual revenue in EUR'
})
};
fetch('https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/suggest-schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/suggest-schema"
payload = { "description": "A CRM of companies with name, industry, website and annual revenue in EUR" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"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>"
}
}{
"error": "InvalidArguments",
"message": "<string>"
}AI
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 --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"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'A CRM of companies with name, industry, website and annual revenue in EUR'
})
};
fetch('https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/suggest-schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/suggest-schema"
payload = { "description": "A CRM of companies with name, industry, website and annual revenue in EUR" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"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>"
}
}{
"error": "InvalidArguments",
"message": "<string>"
}Authorizations
BearerAuthOrgApiKeyAuth
User session JWT. Send as Authorization: Bearer <token>.
Body
application/json
Example:
"A CRM of companies with name, industry, website and annual revenue in EUR"
Response
Suggested schema.
Hide child attributes
Hide child attributes
Column definitions: field name → type descriptor.
Example:
{
"product_name": { "type": "text" },
"price": { "type": "double" },
"stock": { "type": "integer", "nullable": true },
"active": { "type": "boolean" },
"released_at": { "type": "date" },
"specs": { "type": "json" }
}
Was this page helpful?
⌘I