Skip to main content
POST
outreach.copy.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
companyDomain
string
required

The company's website domain, e.g. figma.com.

personName
string
required

The person the drafts address, by full name.

Required string length: 1 - 200
title
string
required

The person's job title.

Required string length: 1 - 200
campaignOffer
string
required

What you are offering, in plain words.

Required string length: 1 - 4000
researchPrompt
string

What kinds of signals the drafts should cite, in plain words.

Required string length: 1 - 2000
lookbackDays
number
default:90

How old a cited signal may be, 1 to 365. Default 90.

Required range: 1 <= x <= 365
runWithoutSignal
boolean
default:false

True drafts from the campaign offer alone: no company signal is researched or claimed. Default false.

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.