Primitives

TAM Builder

Build your TAM (Total Addressable Market) from a natural-language query.

No API key yet? Sign up via Agent Auth to get your X-API-Key - the only required header for this endpoint.

Input

Provide a single natural-language description of your TAM.

Examples:

Build my TAM for cloud observability and monitoring tools
Build my TAM for hospitals and health systems in the US.
Build my TAM for neobanks and digital banks worldwide.
Build my TAM for B2B SaaS companies, Series B+, in North America.
Build my TAM for home service companies serving primarily residential customers.

Results

The endpoint immediately returns a job_id. Poll GET /api/v1/tam/build/{job_id} until status is completed, then walk the result pages using next_cursor.

Cancelling a job

If you need to stop a running or pending job early, call POST /api/v1/tam/build/{job_id}/cancel. The job moves to a transient cancelling state and stops at its next checkpoint; whatever companies were already delivered stay readable via the poll endpoint, and you are charged only for the delivered companies.

Pausing and resuming a job

If you need to pause a running or pending job, call POST /api/v1/tam/build/{job_id}/pause. The job moves to a transient pausing state, the in-flight process finishes and is written, then it settles to paused. Delivered companies stay readable via the poll endpoint, and you are charged only for what’s been delivered so far.

To resume a paused job, call the POST /api/v1/tam/build/{job_id}/resume endpoint. It will continue from the checkpoint where it was paused, only new companies delivered are charged.

POST

api

tam

build

TAM Builder

curl --request POST \
  --url https://api.openfunnel.dev/api/v1/tam/build \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "query": "<string>"
}
'

{
  "job_id": "8a8e8a97-8192-48ff-849a-d8a96e949732",
  "status": "pending",
  "message": "TAM build started. Poll GET /api/v1/tam/build/8a8e8a97-8192-48ff-849a-d8a96e949732 for status and results."
}

Headers

X-API-Key

string

required

Body

application/json

Request body for the async TAM Builder.

query

string

required

Natural-language description of the market to build (e.g. 'cloud observability and monitoring tools').

Required string length: 1 - 500

Response

Job accepted. Returns a job_id to poll for status and results.

Returned immediately when a TAM build job is submitted.

job_id

string

required

Async job id. Poll GET /api/v1/tam/build/{job_id} for status and results.

message

string

required

Human-readable next-step hint.

status

string

default:pending

Job status at submit time (always pending).

Search LookalikesFind lookalike companies from either a natural-language description **or** a set of seed company websites, with optional firmographic filters. <Info>**No API key yet?** [Sign up via Agent Auth](/agent-auth/agent-auth/agent-sign-up) to get your `X-API-Key` - the only required header for this endpoint.</Info> Use it for queries such as: - `Healthcare companies building with voice AI` - `Companies that provide customer support software for B2C` - `Companies that build workflow automation for non technical industries` Or supply 1-10 seed company websites and let OpenFunnel synthesize the query for you: - `seed_domains=datadog.com&seed_domains=grafana.com&seed_domains=dynatrace.com` You can also restrict results to your ICP by applying filters for company size, funding stage, and headquarters country. ## Two input modes At least one of `query` or `seed_domains` is required. Both can be combined for a hybrid trait. - **Natural language** (`query`): describe the kind of company you want. Best when you can articulate the trait in 1-2 sentences. - **Seed-based discovery** (`seed_domains`): pass up to 10 company websites and OpenFunnel uses them to synthesize the lookalike query for you. Best when you can name a few example customers but struggle to phrase what they have in common. - **Both together**: pass `seed_domains` AND `query` - the query becomes a must-have angle layered on top of the seeds (e.g. seeds=[datadog.com, grafana.com] + query="cloud monitoring and observability tools" → synthesized trait targets cloud monitoring tools). With `seed_domains`, the response echoes back the LLM-synthesized `derived_query`, plus `resolved_seed_domains` (seeds that landed in our index) and `unresolved_seed_domains` (seeds we couldn't find - skipped silently as long as at least one resolved). ## Omitting filters If you omit filters, search runs across all company sizes, funding stages, and supported locations. Use the optional firmographic filters below to restrict results to your ICP. ## Discovering available firmographics The `funding_stages`, `locations`, `min_employees`, and `max_employees` filters accept a fixed set of values. Fetch the current set via **`GET /api/v1/account/firmographic-options`** it returns the accepted `funding_stages` labels, the supported HQ `locations` (code + name), and the min/max employee bounds. ## Credits **1 credit per company returned.** Empty result sets are free. The exact amount billed is echoed back in `credits_consumed` on the response. The LLM trait synthesis used by `seed_domains` is included - no extra charge. The response includes a `derived_query` field with the LLM-synthesized trait so you can see exactly what was searched.

⌘I

TAM Builder

curl --request POST \
  --url https://api.openfunnel.dev/api/v1/tam/build \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "query": "<string>"
}
'

{
  "job_id": "8a8e8a97-8192-48ff-849a-d8a96e949732",
  "status": "pending",
  "message": "TAM build started. Poll GET /api/v1/tam/build/8a8e8a97-8192-48ff-849a-d8a96e949732 for status and results."
}