Interpret Lead Filter

Turn a lead filter typed in plain words into a segment's filters (nothing is saved).

API key access

Needs the leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

POST/api/v1/ai/lead-filter

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?X-Workspace-Id

Id of the workspace to act on (must be a member).

Request Body

textText

Which leads, in plain words, e.g. 'spa owners in Texas who replied'.

Length1 <= length <= 300

Response Body

curl -X POST "http://localhost:8000/api/v1/ai/lead-filter" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "string"
  }'

curl -X POST "http://localhost:8000/api/v1/ai/lead-filter" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'

{
  "filters": {},
  "unsupported": [
    "string"
  ],
  "summary": "string",
  "source": "ai"
}

Empty

Authorization

Header Parameters

Request Body

Response Body

200

422