Skip to content
OpenGTM

Enrich Lead

POST
/api/lead/{lead_id}/enrich
curl --request POST \
  --url 'http://localhost:8000/api/lead/1/enrich?action=web_research' \
  --header 'Authorization: Bearer <token>'

AI-powered lead enrichment. Streams SSE progress events.

Actions:

  • web_research: Use LLM + web search to gather company intel
  • find_emails: Discover email patterns for the company
  • scrape_website: Extract data from the company’s website

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
lead_id
required
Lead Id
integer

Query Parameters

Section titled “Query Parameters”
action
Action
string
default: web_research

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}