Skip to main content

DocsREST API and MCP server

AI Analysis API

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

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

Connect Data: AI Analysis

Start AI Analysis

Starts the AI analysis of a run on the data you choose: 201 with the new job, or 200 with the analysis already running on this run (of any data source). The prospect count is reserved from the monthly record allowance first; when less remains the count is lowered to what is left, and with nothing left (or no active plan) it is a 402. Also 404 for an unknown run, 409 while a duplicate start is still settling, 503 when AI analysis is temporarily unavailable; poll Get AI Analysis Job afterwards.

POSThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/runs/:runId/gtmscoop-analysis-jobsTry 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

Parameters

application/json
FieldTypeDescription
runIdpathrequiredstringThe run to analyse. Enrich it first: the analysis works from its matched records.
sourcebodyrequiredstringThe data searched for prospects: "business", "farm" or "property". Missing or anything else is a 400. Cross-Match Counts shows which has matches.
prospectCountbodyintegerProspects to deliver: a whole number from 1 to 5,000, else 400. Omitted: 1. A small candidate pool can deliver fewer; you are only charged for what is delivered.
judgeModebodystringHow candidates are scored: "record" (each one individually; slowest), "segment" (in groups; fastest) or "hybrid" (groups, then the top of the list individually). Default "hybrid". Any other value is a 400.

Mounted at

/api/v1/lead-generation

Finds new lookalike prospects for an enriched run in the dataset you choose. This is what the GTM Scoop web app's AI Analysis step uses: a run has one analysis at a time, each start or resume reserves its prospect count from the plan's monthly record allowance (2,500 Starter / 10,000 Growth, separate from enrichment credits) and is settled to what it actually delivers.

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

Bearer token (llmcp_ API key or session). GTM Scoop accounts only; starts need an active Navigator plan.

MethodPathWhat it does
POST/api/v1/lead-generation/runs/:runId/gtmscoop-analysis-jobs

Start AI Analysis

Starts the AI analysis of a run on the data you choose: 201 with the new job, or 200 with the analysis already running on this run (of any data source). The prospect count is reserved from the monthly record allowance first; when less remains the count is lowered to what is left, and with nothing left (or no active plan) it is a 402. Also 404 for an unknown run, 409 while a duplicate start is still settling, 503 when AI analysis is temporarily unavailable; poll Get AI Analysis Job afterwards.

4 parameters
  • runId (string, required) The run to analyse. Enrich it first: the analysis works from its matched records.
  • source (string, required) The data searched for prospects: "business", "farm" or "property". Missing or anything else is a 400. Cross-Match Counts shows which has matches.
  • prospectCount (integer) Prospects to deliver: a whole number from 1 to 5,000, else 400. Omitted: 1. A small candidate pool can deliver fewer; you are only charged for what is delivered.
  • judgeMode (string) How candidates are scored: "record" (each one individually; slowest), "segment" (in groups; fastest) or "hybrid" (groups, then the top of the list individually). Default "hybrid". Any other value is a 400.
GET/api/v1/lead-generation/runs/:runId/gtmscoop-analysis-jobs/:jobId

Get AI Analysis Job

Reads an analysis job; poll every few seconds until status is completed, failed, cancelled or paused. While it runs, progress gives the stage (index of totalStages) and percent; once completed, progress is {} and summary holds the outcome (prospect_count asked, pool_size candidates, judged, delivered), with matchesFound = delivered. Read the prospects themselves from the run's results.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The id returned by Start AI Analysis or Resume AI Analysis.
Try Get AI Analysis Job in the Playground
DELETE/api/v1/lead-generation/runs/:runId/gtmscoop-analysis-jobs/:jobId

Cancel AI Analysis

Cancels a pending or running analysis: the job ends as cancelled and its reserved allowance is given back once it stops. A job that has already completed, failed or been cancelled is returned unchanged. 404 unless the job is an analysis of this run that you own.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The analysis job to cancel.
PATCH/api/v1/lead-generation/runs/:runId/gtmscoop-analysis-jobs/:jobId

Pause AI Analysis

Asks a running analysis to pause at its next checkpoint. The response shows progress.pause_requested: true; keep polling and status becomes paused once the checkpoint is saved, at which point its allowance hold is given back. An ended job is returned unchanged; 404 unless the job is an analysis of this run.

3 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The running analysis job to pause.
  • action (string, required) Must be "pause". Any other value is a 400.
POST/api/v1/lead-generation/runs/:runId/gtmscoop-analysis-jobs/:jobId/resume

Resume AI Analysis

Continues a paused analysis (or one whose pause is still landing) from its checkpoint as a new job: poll the returned id from now on. It reserves the paused job's prospect count again (lowered to what remains, 402 when nothing does) and needs an active plan. 409 when the job is not paused, 404 for an unknown job; if another analysis is already running on the run, that one is returned instead.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The paused analysis job.
POST/api/v1/lead-generation/runs/:runId/cross-match-counts

Cross-Match Counts

After enrichment, counts how many records in each reference dataset match the upload's phones, emails and addresses (business, farm) or parcel numbers and addresses (property), to help pick an analysis source. available is false when a count is under 0.5% of the upload's rows (minimum 10). Read-only and free, but needs an active plan and allows 10 calls a minute (429 beyond); no request body.

1 parameter
  • runId (string, required) The enriched run. 404 for an unknown run, 400 if its upload has no saved mapping.

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