Skip to main content
POST
outreach.campaign.generate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
signalQuery
string
required

The signal to build the campaign around, in plain words, e.g. a funding event or a hiring push.

campaignOffer
string
required

What you are offering the contact people, in plain words. The drafted emails are written around it.

Required string length: 1 - 4000
signalLimit
number

How many companies the campaign may work through, 1 to 25. Default 10.

Required range: x >= 1
lookbackDays
number
default:90

How old the cited evidence may be, 1 to 365. Default 90.

Required range: 1 <= x <= 365
icpContext
string

Who the campaign is for, in plain words: the ideal customer profile.

Required string length: 1 - 2000
peopleTitles
string[]

Job titles of the contact people to find at each company, at most 20.

Maximum array length: 20
Required string length: 1 - 200
peoplePerCompany
number
default:1

How many contact people to find per company, 1 to 5. Default 1.

Required range: 1 <= x <= 5
copyResearchPrompt
string

What the drafted emails should focus on, in plain words.

Required string length: 1 - 2000

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.