Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Discovery

Start Discovery Run

Find companies that match the workspace ICP (admin+). The run is queued (202) and runs in the background: search queries from the ICP (when a search provider is configured, within a daily request budget), polite crawls of the candidates' websites, a 0-100 fit score with reasons, dedupe against suppressions, companies, leads and earlier candidates. Candidates wait for review; nothing is imported. 409 while a run is in progress, 429 over `DISCOVERY_MAX_RUNS_PER_DAY`, 422 when the ICP names nothing to search for and no seed websites are given.

API key access

Needs the admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
POST/api/v1/discovery/runs

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

max_queries?integer | null
Formatint64
Range1 <= value <= 20
max_pages?integer | null
Formatint64
Range1 <= value <= 100
max_candidates?integer | null
Formatint64
Range1 <= value <= 100
seed_urls?array<string> | null

Company websites to evaluate (acme.com or https://acme.com/), at most 20.

Itemsitems <= 20
directory_urls?array<string> | null

Public pages that list companies (an event's sponsors, a partner directory, a member list), at most 5: each is fetched once and the companies it links to become candidates (a free source; no search provider needed).

Itemsitems <= 5

Response Body

curl -X POST "http://localhost:8000/api/v1/discovery/runs" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "status": "queued",
  "requested_by_id": "e5a2565f-0ccc-4e3e-ace9-5e0c44253010",
  "icp": {
    "property1": null,
    "property2": null
  },
  "limits": {
    "property1": null,
    "property2": null
  },
  "seed_urls": [
    "string"
  ],
  "directory_urls": [
    "string"
  ],
  "queries": [
    "string"
  ],
  "stats": {
    "property1": null,
    "property2": null
  },
  "error": "string",
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "started_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
Empty
Empty

Reject Discovered Company

Reject the candidate: its domain is never proposed again. Idempotent; 409 once accepted.

Approve Email Draft

Approve a pending draft, optionally with a final edit. The runner sends it at its next pass. 409 if the draft isn't pending, or if the lead's enrollment has ended (the draft is then marked `expired`).