set_extraction_schema
Set a structured extraction schema for an inbox by providing a valid JSON Schema to define data to extract from emails.
Instructions
Set structured extraction schema for an inbox.
Args: domain_id: Domain ID for the inbox. inbox_id: Inbox ID. name: Schema name. schema: JSON string of a valid JSON Schema object. description: Optional schema description. enabled: Enable extraction immediately (default: true).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"domain_id": "<domain_id>",
"inbox_id": "<inbox_id>",
"name": "<name>",
"schema": "<schema>"
},
"name": "set_extraction_schema"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain_id | Yes | ||
| inbox_id | Yes | ||
| name | Yes | ||
| schema | Yes | ||
| description | No | ||
| enabled | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |