Skip to main content

DocsREST API and MCP server

Runs API

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

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

Connect Data: Runs

Create Run

Creates a run from an upload, snapshotting its current mapping; status starts as pending and nothing is processed until you start a job on it. With matchOptions null (what the web app and MCP server send), an existing non-failed run of the same upload and mapping is returned instead of a duplicate. 400 if the upload is not found or not yours.

POSThttps://us-farmvision-new-api.onrender.com/api/v1/lead-generation/runsTry 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
uploadIdbodyrequiredstringThe upload to run (a UUID).
matchOptionsbodyobject | nullOptional match preset recorded on the run; when sent, mode and precision are both required (400 otherwise). Leave null for a normal run.
matchOptions.modebodystring"ai" or "data". Any other value reads back as null.
matchOptions.precisionbodystringA precision label, e.g. "loose" (the value runs get when no options are sent).
matchOptions.fieldsbodyarray<string>Fields the preset matches on. Anything that is not an array is stored as [].

Mounted at

/api/v1/lead-generation

A run is one pass over a mapped upload. Create a run, start enrichment or AI analysis jobs on it (see their own sections), and use these endpoints to list runs and follow their jobs.

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: an llmcp_ API key or a signed-in session token.

MethodPathWhat it does
POST/api/v1/lead-generation/runs

Create Run

Creates a run from an upload, snapshotting its current mapping; status starts as pending and nothing is processed until you start a job on it. With matchOptions null (what the web app and MCP server send), an existing non-failed run of the same upload and mapping is returned instead of a duplicate. 400 if the upload is not found or not yours.

5 parameters
  • uploadId (string, required) The upload to run (a UUID).
  • matchOptions (object | null) Optional match preset recorded on the run; when sent, mode and precision are both required (400 otherwise). Leave null for a normal run.
  • matchOptions.mode (string) "ai" or "data". Any other value reads back as null.
  • matchOptions.precision (string) A precision label, e.g. "loose" (the value runs get when no options are sent).
  • matchOptions.fields (array<string>) Fields the preset matches on. Anything that is not an array is stored as [].
GET/api/v1/lead-generation/runs

List Runs

Your 200 most recent runs, newest first, each with its live (pending or running) job merged in as activeJob, or null. hasEnrich is always false in this list; Get Run reports it.

Try List Runs in the Playground
DELETE/api/v1/lead-generation/runs/:runId

Delete Run

Removes a run from your history. The upload, its rows and any other runs of it are kept. 404 if the run is not yours or does not exist.

1 parameter
  • runId (string, required) The run's id (a UUID).
GET/api/v1/lead-generation/active-jobs

List Active Jobs

Every enrichment or analysis job you have pending or running, newest first, with its progress and file name: built to be polled every few seconds. Returns an empty list, not a 404, when nothing is running.

Try List Active Jobs in the Playground
GET/api/v1/lead-generation/runs/:runId/match-jobs

List Run Match Jobs

A run's jobs, newest first (up to 100), finished ones included: use it to find a run's latest analysis job when you don't have its id. Enrichment jobs are left out unless includeEnrich=1. 404 if the run is not yours or does not exist.

3 parameters
  • runId (string, required) The run's id (a UUID).
  • mode (string) Only jobs of this mode: ai_data_match (business analysis), ai_data_match_farm, ai_data_match_property; with includeEnrich=1 also enrich, enrich_farm, enrich_property.
  • includeEnrich (string) "1" includes enrichment jobs in the list.
Try List Run Match Jobs in the Playground
POST/api/v1/lead-generation/runs/:runId/match-jobs/:jobId/execute

Execute Match Job (Status Check)

Kept for clients that try to restart a job they find stuck at pending: it starts nothing and returns the job's current state (data is null if it cannot be read back). Safe to call repeatedly; the server restarts stalled jobs on its own. 404 if the job is not yours or does not belong to this run.

2 parameters
  • runId (string, required) The run's id (a UUID).
  • jobId (string, required) The job's id (a UUID), from List Run Match Jobs or a job start response.

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