| POST | /api/v1/lead-generation/prospect-report/intel/directory | Prospect Intel: Directory Lookup The fast, free first step: matches the prospect in the business, farm or property directory and returns its fact sheet (details, key facts, people, emails, signals), each fact tagged with a status and its sources, plus a computed confidence. No AI is involved; results are cached for up to 6 hours. 404 if the run is not yours; counts toward the 400-per-hour limit on lookups, flags and PDF downloads. 5 parametersrunId (string, required) The analysis run the prospect came from (up to 100 characters), or purchase:<purchaseId>:<farm|business|property> for a record from a paid purchased list.companyName (string, required) The prospect's name, 1-200 characters.companyUrl (string) The prospect's website, up to 2,048 characters.record (object) The prospect's row as column label → value. Blank cells and nested values are dropped, at most 60 columns are kept and each value is cut to 300 characters. A ZIP, phone or city and state is needed for a confident directory match.kind (string) business, farm or property: which directory to search. Guessed from the record's columns when omitted.
|
| POST | /api/v1/lead-generation/prospect-report/intel/full | Prospect Intel: Web Verification The same fact sheet cross-checked against AI web research: facts found on the company's own pages become "confirmed", disagreements become "conflict", and news, hiring signals and website technologies are added. A completed check is reused for up to 7 days for anyone who opens the same company and record (cached: true), but every call still counts against the AI report budget (120 per day per account by default); web research is skipped for records that look like a private individual (web.state "skipped"). 5 parametersrunId (string, required) A run id, or purchase:<purchaseId>:<farm|business|property>. 404 if it is not yours.companyName (string, required) The prospect's name, 1-200 characters.companyUrl (string) The prospect's website, up to 2,048 characters.record (object) The prospect's row (same rules as Directory Lookup). Send the same record so the cached result matches.kind (string) business, farm or property. Guessed from the record when omitted.
|
| POST | /api/v1/lead-generation/prospect-report/latest | Get Latest Prospect Report Returns the last report this account generated for this run and company, with the plan and fact sheet it was built from, at no AI cost; { "found": false } when there is none. Call it whenever a prospect opens and only build a new report when nothing is found or the user asks to regenerate. 2 parametersrunId (string, required) The run id (or purchase:<purchaseId>:<dataset>) the report was generated for.companyName (string, required) The prospect's name as sent to /generate (matched without regard to case).
|
| POST | /api/v1/lead-generation/prospect-report/annotations | Get Prospect Flags and Feedback This account's active "this fact is wrong" flags and its good/bad lead verdict for one prospect. feedback is null when no verdict is set. 2 parametersrunId (string, required) A run id or purchase:<purchaseId>:<dataset>, up to 100 characters.companyName (string, required) The prospect's name, 1-200 characters.
|
| POST | /api/v1/lead-generation/prospect-report/flag | Flag a Prospect Fact Marks one fact in the report as inaccurate, optionally with the value you believe is right; send flagged: false to remove the flag. Flags are kept per account as a data-quality signal and never change the directory or the fact sheet. 400 if fieldKey or flagged is missing. 8 parametersrunId (string, required) A run id or purchase:<purchaseId>:<dataset>, up to 100 characters.companyName (string, required) The prospect's name, 1-200 characters.fieldKey (string, required) Which fact, 1-200 characters: a detail or key-fact key from the fact sheet (e.g. phone, revenue), email:<address> for an email, person:<name> for a person.fieldLabel (string) The fact's display label, up to 120 characters.oldValue (string) The value the report showed, up to 400 characters.proposedValue (string) The value you believe is right, up to 400 characters.reason (string) Why it is wrong, up to 500 characters.flagged (boolean, required) true to flag the fact, false to remove an existing flag.
|
| POST | /api/v1/lead-generation/prospect-report/feedback | Rate a Prospect Records a good or bad lead verdict for the whole report, stored with the score, rating and tier the report showed; an empty verdict clears it. One verdict per account, run and company, and a new one replaces the old. 400 if verdict is missing or not one of the allowed values. 7 parametersrunId (string, required) A run id or purchase:<purchaseId>:<dataset>, up to 100 characters.companyName (string, required) The prospect's name, 1-200 characters.verdict (string, required) "good", "bad", or "" to clear the verdict.note (string) Free text, up to 500 characters.fitScore (number) The fit score the report showed, 0-100.rating (string) The rating label the report showed (e.g. Good), up to 20 characters.tier (string) The priority tier the report showed: A, B, C or "".
|
| POST | /api/v1/lead-generation/prospect-report/plan | Plan a Prospect Report Step 1: works out what the report must answer for this prospect given what you sell: an objective, your offering and ideal customer, nine checks (activity, fit, demand, locations, workforce, revenue, expansion, reach, upsell) and the facts already known. Send the record and the fact sheet for a better plan, review or edit the plan, then pass it to /generate. Counts against the AI report budget (120 per day per account by default); 502 if the plan could not be built. 6 parametersrunId (string, required) A run id or purchase:<purchaseId>:<dataset>. 404 if it is not yours.companyName (string, required) The prospect's name, 1-200 characters.companyUrl (string) The prospect's website, up to 2,048 characters; read as supporting evidence.record (object) The prospect's row; the primary source for the plan (same trimming rules as Directory Lookup).offering (string) What you sell and to whom, up to 2,000 characters. When omitted, the business context saved with the run's upload is used (for a purchased list, the one saved with your latest upload).intel (object) The fact sheet from /intel/directory or /intel/full, as returned. Re-checked on the server; malformed parts are dropped.
|
| POST | /api/v1/lead-generation/prospect-report/generate | Generate Prospect Report Steps 2-3: builds the report from the plan: a fit score with its factors, rating and A/B/C tier, demand model, locations, buying signals, ICP match, 30/60/90-day plan, outreach cadence and scripts, and objections. Factual claims about the prospect are kept only when they can be quoted from its record, fact sheet or website, and scores are computed from verified facts; the report is stored and returned by /latest until you generate again. Counts against the AI report budget (120 per day per account by default); 502 if the report could not be generated. 13 parametersrunId (string, required) A run id or purchase:<purchaseId>:<dataset>. 404 if it is not yours.companyName (string, required) The prospect's name, 1-200 characters. /latest finds the report by this name.companyUrl (string) The prospect's website, up to 2,048 characters.record (object) The prospect's row. Its phone, email, address, website, headcount and revenue always win over other sources.plan (object, required) The plan from /plan, as returned or edited. Only checks with enabled: true are answered.plan.objective (string, required) Up to 3,000 characters.plan.seller (object, required) { offering, idealCustomer }, strings up to 3,000 characters.plan.prospectType (string, required) Up to 400 characters.plan.checks (array, required) Up to 12 { id, label, question, enabled }: id is activity, fit, demand, locations, workforce, revenue, expansion, reach or upsell; label up to 160 and question up to 500 characters.plan.knownFacts (array, required) Up to 12 { label, value }, label up to 80 and value up to 300 characters.plan.reachApproach (string, required) Up to 3,000 characters.plan.upsellHypothesis (string, required) Up to 3,000 characters.intel (object) The fact sheet from /intel/full (or /intel/directory). Recommended: only people named in it can appear in the report, and it drives the contact block and the scores.
|
| POST | /api/v1/lead-generation/prospect-report/pdf | Download Prospect Report PDF Renders a report as a PDF and returns the file itself (application/pdf, as an attachment). Send the report object exactly as /generate or /latest returned it; demand optionally overrides the volume-model assumptions so the PDF matches numbers adjusted on screen. 400 if the report does not validate; counts toward the 400-per-hour limit, not the AI budget. 3 parameterscompanyName (string, required) Up to 200 characters; used in the file name.report (object, required) The report from /generate or /latest. Required: companyName, headline, fitScore, summary, scores, activity, offeringFit, demand, financials, workforce, locations, expansions, reach, upsell, risks, confidence, contact; deep, strategy, insights and intel are optional.demand (object) Replaces report.demand: { unitLabel, locations (1-500), unitsPerLocationPerYear (0-100,000), avgDealValueUsd, winRatePct (0-100), modelled?, rationale }.
|
| POST | /api/v1/lead-generation/prospect-report/email-pdf | Email Prospect Report PDF The same PDF, emailed to the signed-in account's own address (the recipient cannot be chosen); the response echoes that address. Unlike /pdf it counts against the AI report budget. 400 if the report does not validate or the account has no email address on file, 503 when email delivery is not set up, 502 if sending fails. 3 parameterscompanyName (string, required) Up to 200 characters; used in the email subject and the file name.report (object, required) The report from /generate or /latest (same rules as Download Prospect Report PDF).demand (object) Replaces report.demand so the PDF matches assumptions adjusted on screen.
|