Get API key

    Reference/Discovery

    POST/v1/discovery

    Launch lead discovery

    Starts finding leads for an agent. The agent needs Memory filled in first. mode picks the search style.

    Full URL

    POST https://api.tryleadreach.com/v1/discovery

    Headers

    • X-Api-Key (required): your API key from the app Keys tab.
    • Content-Type: application/json (required)

    Path params (in the URL)

    None

    Query params (after ?)

    None

    Request body (JSON)

    FieldTypeRequiredMeaning
    agentIduuidYesWhich agent's campaign to search for.
    modestringYes"people", "company", or "pain".
    targetCountnumberNoHow many leads to aim for.
    discoveryDepthstringNo"fast" or "deep".

    Example request (JSON)

    What you send: headers, and path / query / body when used.

    {
      "headers": {
        "X-Api-Key": "lr_your_key_here",
        "Content-Type": "application/json"
      },
      "body": {
        "agentId": "a1111111-1111-1111-1111-111111111111",
        "mode": "people",
        "targetCount": 10
      }
    }

    Example response (JSON)

    Typical successful response shape.

    {
      "ok": true,
      "campaignId": "c1111111-1111-1111-1111-111111111111",
      "mode": "people"
    }

    Response

    JSON describing the launched discovery (or an error if Memory is incomplete / 402 if out of credits).

    Credits

    discovery run