Sign in

v27

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-06-0872127230.6 KB
Warm Leads

Start a Citedy warm-lead report

Creates one tenant-scoped warm-lead run for one company domain. Accepted new runs charge exactly 40 Citedy credits. Poll GET /api/agent/citedy-warm-lead/{runId} for status and result.

post/api/agent/citedy-warm-lead

Request body

domainstring required

One company domain. Bare domains and http(s) URLs are accepted, but paths/social profile URLs are rejected.

icp'seo-geo-agency' | 'content-led-saas' | 'vertical-saas'

Ideal customer profile. Defaults to content-led-saas when omitted.

buyerRolesstring[]
maxContactsinteger

Maximum buyer candidates. Defaults to 3 when omitted.

draftsinteger

Maximum outreach drafts. Defaults to 3 when omitted.

freshnessDaysinteger

Evidence lookback window in days. Defaults to 90 when omitted.

idempotencyKeystring

Response

Existing idempotent warm-lead run returned without a new credit charge

credits_chargedinteger required
idempotentboolean