Skip to main content

DocsREST API and MCP server

AI Helpers API

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

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

Prospect Intelligence: AI Helpers

Business Context from Website

Reads a company's public website and writes a 3-6 sentence business-context paragraph: what it sells, who it targets and where. Save it in an upload's businessContext so the prospect report knows what you sell. If the site cannot be read, the paragraph is written from the name alone and source is "company_only"; limited to 30 requests per hour per account.

POSThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/business-context/from-websiteTry 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
companyNamebodystringYour company name, up to 200 characters. Required when website is empty.
websitebodystringYour public website, up to 2,048 characters; https:// is added when no scheme is given. http/https on the default ports only; private, internal and local addresses are refused. Required when companyName is empty.

Mounted at

/api/v1/lead-generation

Small AI helpers for the upload step: draft a business-context paragraph from your own website, split a spoken description into form fields, and turn an ideal-customer description into a structured profile. Every call needs an active Navigator subscription (402 without one) and spends a per-account AI budget (429 once it is used up).

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 4 endpoints in this section

Bearer token (API key or session); an active Navigator subscription is required.

MethodPathWhat it does
POST/api/v1/lead-generation/business-context/from-website

Business Context from Website

Reads a company's public website and writes a 3-6 sentence business-context paragraph: what it sells, who it targets and where. Save it in an upload's businessContext so the prospect report knows what you sell. If the site cannot be read, the paragraph is written from the name alone and source is "company_only"; limited to 30 requests per hour per account.

2 parameters
  • companyName (string) Your company name, up to 200 characters. Required when website is empty.
  • website (string) Your public website, up to 2,048 characters; https:// is added when no scheme is given. http/https on the default ports only; private, internal and local addresses are refused. Required when companyName is empty.
POST/api/v1/lead-generation/ideal-customer/voice-parse

Parse Voice Transcript

Splits a speech-to-text transcript into your company name and an ideal-customer description, ready to send to Analyze Ideal Customer. Only the first 5,000 characters are read, and an empty transcript returns two empty strings. Shares the ideal-customer budget (10 requests per minute, 100 per day per account) with the two analyze endpoints.

1 parameter
  • transcript (string) What the user said. Text past 5,000 characters is ignored.
POST/api/v1/lead-generation/ideal-customer/analyze

Analyze Ideal Customer

Turns a free-text ideal-customer description into a structured profile: a summary, ideal traits, the data categories to prioritize, a matching focus and column-mapping notes. 400 when companyName and description are both empty. Shares the ideal-customer budget (10 per minute, 100 per day per account).

2 parameters
  • companyName (string) Your company name. Text past 200 characters is ignored. Required when description is empty.
  • description (string) Who your ideal customer is. Text past 8,000 characters is ignored. Required when companyName is empty.
POST/api/v1/lead-generation/ideal-customer/analyze-stream

Analyze Ideal Customer (Streaming)

The same analysis, streamed as newline-delimited JSON (application/x-ndjson): delta events carry the narration as it is written, then one profile event carries the same object Analyze Ideal Customer returns. Once the stream starts it answers 200; if the AI is unavailable or the input is empty, a simpler built-in analysis is streamed instead, and an error event appears only if that also fails. Shares the ideal-customer budget (10 per minute, 100 per day per account).

2 parameters
  • companyName (string) Your company name. Text past 200 characters is ignored.
  • description (string) Who your ideal customer is. Text past 8,000 characters is ignored.

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