| POST | /api/v1/lead-generation/ai-search/classify | Classify AI Search Request Says which datasets a plain-language request is about (farm, business, property; usually just one), so you know which to send to /extract or /messages. Falls back to ["farm"] if classification fails. Has its own budget, the same size as the AI Search budget, so classifying doesn't halve your searches. 1 parametertext (string, required) The request in plain language, up to 2,000 characters.
Try Classify AI Search Request in the Playground |
| POST | /api/v1/lead-generation/ai-search/extract | Extract AI Search Filters Turns text into one dataset's filters without saving anything or running a count. Farm returns the full field-keyed filter object (unused fields empty); business and property return the { filterId, values, exclude } list. Counts against the AI Search budget. 3 parameterstext (string, required) The request in plain language, up to 2,000 characters.dataset (string) "farm" (default), "business" or "property".hintStates (string[]) States already selected. Helps resolve a place name that exists in several states.
Try Extract AI Search Filters in the Playground |
| POST | /api/v1/lead-generation/ai-search/messages | Send AI Search Message Runs one chat turn: extracts filters from text, merges them onto the chat's latest turn (or replyToMessageId's), saves the turn and returns it with resultCount (farm records, or distinct farm locations with a radius; deduplicated business contacts; property records). Omit sessionId to start a new chat. 400 once a chat reaches 100 messages or too many criteria (start a new chat), 404 for an unknown chat or reply. 6 parameterstext (string, required) The request in plain language, up to 2,000 characters.dataset (string) "farm" (default), "business" or "property". Keep to one dataset per chat.sessionId (string) Continue this chat. Omit to start a new one, titled with the first 60 characters of text.replyToMessageId (string) Build on this earlier message's criteria instead of the latest turn's.hintStates (string[]) States already selected. Helps resolve a place name that exists in several states.precomputed (object) { filters, unmatched } from /extract for the same text and dataset; skips the AI step. At most 20,000 characters as JSON.
|
| GET | /api/v1/lead-generation/ai-search/sessions | List AI Search Sessions This account's AI Search chats, most recently active first. Timestamps here are UTC with no zone suffix. Try List AI Search Sessions in the Playground |
| GET | /api/v1/lead-generation/ai-search/sessions/:id/messages | List Session Messages Every turn in one chat, oldest first, each with the merged filters and count it produced. Timestamps are UTC with no zone suffix. 404 if the chat isn't this account's or was deleted. 1 parameterid (string, required) The chat's sessionId.
Try List Session Messages in the Playground |
| DELETE | /api/v1/lead-generation/ai-search/sessions/:id | Delete AI Search Session Deletes one chat. 404 if it isn't this account's or is already deleted. 1 parameterid (string, required) The chat's sessionId.
|
| DELETE | /api/v1/lead-generation/ai-search/sessions | Delete All AI Search Sessions Deletes every chat this account has. Succeeds even when there are none. Needs a signed-in web-app session: an API key or a connected AI app gets 403 (deleting one chat by id still works with a key). |