Read the values a workspace uses
readOptionsThe exact values this workspace uses for one kind of thing, as stored: its segments (with ids), contact sources and statuses, the topics its tracked prompts are filed under, its tracked prompts, its competitors, its keywords. Use it before a filter or before adding a prompt, a keyword or a competitor that may be there already. With match (what the person said), only the values that match it come back, ignoring case and accents; when none does, closest has the nearest spellings to ask the person about, so a filter on 'vip' finds the segment called 'VIP Clienti' instead of nothing.
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": {
"kind": "<kind>"
},
"name": "readOptions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| match | No | What the person said, to find the stored value it means | |
| workspaceId | No | The workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| total | Yes | ||
| values | Yes | ||
| closest | Yes |