Skip to main content

DocsREST API and MCP server

AI Search API

Endpoints, auth and live samples for Audience Builder, Connect Data and CRM sync.

Base URLhttps://us-farmvision-new-api.onrender.com

Audience Builder: AI Search

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.

POSThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/ai-search/classifyTry it

In this section

Authentication

Get API key

Bearer token

Send your GTM Scoop API key (llmcp_…) or a signed-in session token as a Bearer token.

Authorization: Bearer YOUR_API_KEY

Request body

application/json
FieldTypeDescription
textbodyrequiredstringThe request in plain language, up to 2,000 characters.

Mounted at

/api/v1/lead-generation/ai-search

The Navigator's AI Search: classify a plain-language request by dataset, extract filters from it, or run it as a chat turn that builds on the chat's earlier turns and returns a live count. Chats are saved per account; /classify, /extract and /messages count against a per-account AI Search budget (by default 20 a minute and 300 a day, or 50 a day without an active Navigator subscription).

Try it in the playground

Signed out: 10 free tries a day with names hidden. Log in for live data.

Open playground

Related endpoints

All 7 endpoints in this section

Bearer token: an API key (llmcp_...) or a signed-in session token.

MethodPathWhat it does
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 parameter
  • text (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 parameters
  • text (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 parameters
  • text (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 parameter
  • id (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 parameter
  • id (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).

Cookies on GTM Scoop

Essential cookies keep you signed in and the site secure, and are always on. Optional cookies (Google Analytics) help us understand how the site is used. They are on by default, except in the EU/EEA, the UK and Switzerland, where they stay off until you choose Accept All Cookies; choose Essential Cookies Only to turn them off. We do not use advertising cookies and we do not sell or share your personal information. The site works the same whichever you choose. We keep a record of your choice with the date, your IP address and the page you were on. Cookie Policy · Privacy Policy