Skip to main content
All tools operate within the workspace bound to the API key. Each tool requires the scope listed alongside it.

Campaigns

list_campaigns

Lists campaigns in the workspace. Requires interviews. Returns: array of campaign summaries with contact counts.

get_campaign

Fetches a single campaign by id. Requires interviews.

create_campaign

Creates a new campaign. Requires interviews.

start_campaign / pause_campaign

Lifecycle controls. Each takes interview_id and returns the new status.

add_contacts

Bulk-adds contacts. Requires interviews.

get_progress

Returns total / completed / completion percent.

Transcripts

list_conversations

Lists conversations in a campaign. Requires interviews.

get_transcript

Returns full transcript text plus contact metadata. Requires interviews.

export_transcript_markdown

Returns the transcript rendered as Markdown. Requires exports.

export_report_markdown

Returns the full synthesis report (cartography + roadmap + personas) as Markdown. Requires exports.

Synthesis

get_roadmap

Returns solutions grouped by horizon. Requires interviews.

get_personas

Returns per-contact personas, optionally filtered by department. Requires interviews.

query_campaign

Runs a GraphRAG query across the campaign’s transcripts. Requires interviews. Returns: {answer, patterns[], divergences[], verifications[]}.

Webhooks

list_webhooks

Returns the workspace’s webhook subscriptions. Requires webhooks.

add_webhook

Creates a subscription. Requires webhooks. Returns {id, secret, url, events} — the secret is only shown here.

remove_webhook

Deletes a subscription. Requires webhooks.