Skip to main content
POST
Create a source agent

Authorizations

Authorization
string
header
required

API key from Settings → API. Send it as Authorization: Bearer .

Headers

x-impersonate-user-id
string

ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.

Body

application/json
name
string
required

Name of the source agent

Example:

"SaaS CTOs - Europe"

listId
number
required

ID of the list the agent imports its sourced leads into. A list is mandatory: create one first (POST /v1/list) and pass its ID here. The list must belong to the authenticated user.

Example:

123

targetJobTitles
string[]
required

Target job titles to search for

Example:
targetIndustries
string[]
required

Target industries to search in

Example:
targetCompanySizes
enum<string>[]
required

Target company sizes

Available options:
2-10,
11-50,
51-200,
201-500,
501-1000,
1001-5000,
5001-10000,
10001+
Example:
targetLocations
string[]
required

Target locations to search in

Example:
targetCompanyTypes
enum<string>[]
required

Target company types

Available options:
All company types,
Private Company,
Public Company,
Startup,
Non-profit,
Government,
Educational Institution,
Other
Example:
agentType
enum<string>
default:autopilot

Type of agent: "autopilot" (default), "lookalike" or "website-visitor".

Available options:
autopilot,
lookalike,
website-visitor
variables
object[]

The signals the agent tracks to find leads. Each variable is one signal: one keyword, one LinkedIn URL, one event, or one technology. Send between 4 and 15 variables. An "autopilot" agent created without variables has no signal to run. Optional for "website-visitor" agents (the website visitor signal is added automatically) and not allowed for "lookalike" agents. Each variable needs a type and a value whose format depends on the type. See value for every type: quoted keyword, LinkedIn page URL, "true" for event signals, or lowercase technology name. Values are not validated: a malformed keyword, URL, or technology is saved anyway, and that signal then finds no leads or the wrong ones. LOOKALIKE variables are refused, and JOB_SEARCH variables are refused for now.

Example:
ignoredCompanies
string[]

Companies to ignore in search results

mandatoryKeywords
string[]

Keywords that must be present in the profile

excludeServiceProviders
boolean

Exclude service providers from results

skipIcpFilter
boolean

Skip ICP (Ideal Customer Profile) filter

includeOpenToWorkProfiles
boolean

Include open-to-work profiles in results

leadWaterfall
boolean

Enable smart lead finder mode, usually true

paused
boolean

Create the agent paused. Note: the agent is also created paused when the active agent limit is reached.

minLeadScore
number

Minimum lead score threshold (0–1) - Usually 0.6 or 0.8

maxCreditUsage
number

Max number of credits per month (website visitor agent only)

Response

Agent created

id
number
required

Unique identifier

name
string
required

Display name of the agent

targetJobTitles
string[]
required

List of target job titles to prospect. Part of the ICP.

targetIndustries
string[]
required

List of target industries to prospect. Part of the ICP.

targetCompanySizes
string[]
required

List of target company sizes (e.g. "1-10", "11-50"). Part of the ICP.

targetLocations
string[]
required

List of target geographic locations. Part of the ICP.

targetCompanyTypes
string[]
required

List of target company types (e.g. "Public", "Private")

agentType
string
required

Type of agent: "autopilot", "lookalike" or "website-visitor"

Example:

"autopilot"

scriptInstalled
boolean
default:false
required

Whether the visitor tracking script is installed on the website (website-visitor agents)

currentCreditUsage
number
default:0
required

Credits consumed so far in the current period (e.g. website-visitor company identifications)

paused
boolean
default:false
required

Whether the agent is paused and will not run on its next scheduled time

excludeServiceProviders
boolean
default:false
required

Whether to exclude service provider companies from prospecting

skipIcpFilter
boolean
default:false
required

Whether to skip the ICP (Ideal Customer Profile) filter when sourcing leads

includeOpenToWorkProfiles
boolean
default:false
required

Whether to include LinkedIn profiles marked as open to work

leadWaterfall
boolean
default:true
required

Whether to use the lead waterfall strategy (cascade through multiple sources)

userId
number
required

ID of the account (user) who owns this agent

createdAt
string<date-time>
required

Creation timestamp

updatedAt
string<date-time>
required

Last update timestamp

additionalCriteria
string | null

Additional free-text targeting criteria

variables
string[] | null

Variables used by the agent to find high intent leads. (Keywords, Competitor Page URL, etc.)

ignoredCompanies
string[] | null

Company names to exclude from prospecting. Part of the ICP.

mandatoryKeywords
string[] | null

Keywords that must be present in a lead profile to be included

trackingScriptId
string | null

Snitcher tracking script ID, used as the profileId in the tracking snippet (website-visitor agents)

maxCreditUsage
number | null

Max number of credits per month

Example:

200

lastRun
string<date-time> | null

Timestamp of the last agent execution

minLeadScore
number | null

Minimum lead score threshold (0.00–1.00) required to include a lead

Example:

0.75

listId
number | null

ID of the list this agent sources contacts into