Skip to main content

DocsREST API and MCP server

AI Match by Dataset 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 Match by Dataset

Start Business AI Match

Starts a business-data analysis (201), or returns the analysis already active on the run, of any dataset (200). On a run created through this API prospectCount defaults to 5,000, the most an analysis can deliver, so set it to what you want reserved from the allowance. 404 for an unknown run, 409 while a duplicate start is settling, 503 when AI analysis is temporarily unavailable.

POSThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/runs/:runId/ai-data-match-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.
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.
prospectCountbodyintegerProspects to deliver, capped at 5,000 (larger values are lowered, not refused). Omitted or not a positive number: 5,000 (1 on runs created by the MCP server).
sourcebodystringOnly honoured on runs created by the GTM Scoop MCP server, where "farm" or "property" starts that dataset's analysis instead (scored in segments). Ignored on runs you create through this API: they always get a business analysis.

Mounted at

/api/v1/lead-generation

The same AI analysis as Start AI Analysis, with one route family per dataset; the GTM Scoop MCP server's AI match tools work the same way, while Start AI Analysis covers every dataset with one route and is the one to prefer. A run still has one analysis at a time across all of them, and every start or resume reserves its prospect count from the monthly record allowance (lowered to what remains, 402 when nothing does).

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

Bearer token (llmcp_ API key or session). Starts and resumes need an active Navigator plan.

MethodPathWhat it does
POST/api/v1/lead-generation/runs/:runId/ai-data-match-jobs

Start Business AI Match

Starts a business-data analysis (201), or returns the analysis already active on the run, of any dataset (200). On a run created through this API prospectCount defaults to 5,000, the most an analysis can deliver, so set it to what you want reserved from the allowance. 404 for an unknown run, 409 while a duplicate start is settling, 503 when AI analysis is temporarily unavailable.

4 parameters
  • runId (string, required) The run to analyse. Enrich it first: the analysis works from its matched records.
  • 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.
  • prospectCount (integer) Prospects to deliver, capped at 5,000 (larger values are lowered, not refused). Omitted or not a positive number: 5,000 (1 on runs created by the MCP server).
  • source (string) Only honoured on runs created by the GTM Scoop MCP server, where "farm" or "property" starts that dataset's analysis instead (scored in segments). Ignored on runs you create through this API: they always get a business analysis.
GET/api/v1/lead-generation/runs/:runId/ai-data-match-jobs/:jobId

Get Business AI Match Job

Reads an analysis job on this run; same shape and polling rules as Get AI Analysis Job (summary is filled in once status is completed). 404 if the job is not on this run or not yours.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The id returned by Start Business AI Match or its resume.
Try Get Business AI Match Job in the Playground
DELETE/api/v1/lead-generation/runs/:runId/ai-data-match-jobs/:jobId

Cancel Business AI Match

Cancels a pending or running analysis of this run, whichever dataset it searches; its reserved allowance is given back once it stops. An ended job 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/ai-data-match-jobs/:jobId

Pause Business AI Match

Asks a running analysis of this run (any dataset) to pause at its next checkpoint; the response shows progress.pause_requested: true and status becomes paused once the checkpoint is saved. Only action "pause" is accepted. 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/ai-data-match-jobs/:jobId/resume

Resume Business AI Match

Continues a paused analysis of this run from its checkpoint as a new job (poll the returned id). 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, and 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/farm-ai-data-match-jobs

Start Farm AI Match

Starts a farm-data analysis (201), or returns the analysis already active on the run, of any dataset (200). prospectCount defaults to 1 and is reserved from the monthly record allowance. 404 for an unknown run, 409 while a duplicate start is settling, 503 when AI analysis is temporarily unavailable.

3 parameters
  • runId (string, required) The run to analyse. Enrich it first: the analysis works from its matched records.
  • 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.
  • prospectCount (integer) Prospects to deliver, capped at 5,000 (larger values are lowered, not refused). Omitted or not a positive number: 1.
GET/api/v1/lead-generation/runs/:runId/farm-ai-data-match-jobs/:jobId

Get Farm AI Match Job

Reads a farm analysis job; poll until status is completed, failed, cancelled or paused (summary is filled in once completed). 404 unless the job is a farm analysis of this run that you own.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The id returned by Start Farm AI Match or its resume.
Try Get Farm AI Match Job in the Playground
DELETE/api/v1/lead-generation/runs/:runId/farm-ai-data-match-jobs/:jobId

Cancel Farm AI Match

Cancels a pending or running farm analysis; its reserved allowance is given back once it stops. An ended job is returned unchanged; 404 unless the job is a farm 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/farm-ai-data-match-jobs/:jobId

Pause Farm AI Match

Asks a running farm analysis to pause at its next checkpoint; the response shows progress.pause_requested: true and status becomes paused once the checkpoint is saved. Only action "pause" is accepted. 404 unless the job is a farm 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/farm-ai-data-match-jobs/:jobId/resume

Resume Farm AI Match

Continues a paused analysis of this run from its checkpoint as a new job (poll the returned id). 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, and 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/property-ai-data-match-jobs

Start Property AI Match

Starts a property-data analysis (201), or returns an active farm or property analysis of the run (200); a business analysis still running on the run is a 409 instead. prospectCount defaults to 1 and is reserved from the monthly record allowance. 404 for an unknown run, 503 when AI analysis is temporarily unavailable.

3 parameters
  • runId (string, required) The run to analyse. Enrich it first: the analysis works from its matched records.
  • 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.
  • prospectCount (integer) Prospects to deliver, capped at 5,000 (larger values are lowered, not refused). Omitted or not a positive number: 1.
GET/api/v1/lead-generation/runs/:runId/property-ai-data-match-jobs/:jobId

Get Property AI Match Job

Reads a property analysis job; poll until status is completed, failed, cancelled or paused (summary is filled in once completed). 404 unless the job is a property analysis of this run that you own.

2 parameters
  • runId (string, required) The run the job belongs to.
  • jobId (string, required) The id returned by Start Property AI Match or its resume.
Try Get Property AI Match Job in the Playground
DELETE/api/v1/lead-generation/runs/:runId/property-ai-data-match-jobs/:jobId

Cancel Property AI Match

Cancels a pending or running property analysis; its reserved allowance is given back once it stops. An ended job is returned unchanged; 404 unless the job is a property 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/property-ai-data-match-jobs/:jobId

Pause Property AI Match

Asks a running property analysis to pause at its next checkpoint; the response shows progress.pause_requested: true and status becomes paused once the checkpoint is saved. Only action "pause" is accepted. 404 unless the job is a property 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/property-ai-data-match-jobs/:jobId/resume

Resume Property AI Match

Continues a paused analysis of this run from its checkpoint as a new job (poll the returned id). 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, and 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.

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