Tools Reference

Check your identity — returns your user ID, org ID, and auth type. Use this to verify your API key is working.

List all brands in your organization.

Get detailed information about a specific brand, including bio, mission, location, and categories.

Create a new brand by providing its website URL. The platform will automatically scrape and analyze the site.

Extract specific information fields from one or more brands using AI. Results are cached for 30 days. Use this to get structured data like industry, target audience, value proposition, etc.

List all available automation features (e.g. Sales Cold Email Outreach, Journalist Pitch, Press Kit Generation). Each feature defines a type of campaign you can run.

Get details of a specific feature, including its required inputs, outputs, charts, and entities.

Pre-fill a feature's input fields using brand data. Returns suggested values for each input based on the brand's website analysis.

Get performance statistics for a specific feature — total cost, completed runs, active campaigns, and custom stats. Can be grouped by brand, campaign, or workflow.

Get aggregate performance statistics across all features. Can be grouped by feature or brand.

Get the stats key registry — maps stat keys to their type (count, rate, currency) and human-readable label.

List campaigns. Optionally filter by brand to see all campaigns for a specific brand.

Get details of a specific campaign including its status, workflow, brand, feature inputs, and budget settings.

Create and launch a new campaign. Requires a workflow slug, brand URL(s), and optionally budget limits and feature inputs. The campaign starts running immediately.

Stop a running campaign. The campaign can be viewed afterwards but will no longer execute.

Get performance statistics for a campaign — leads served, emails sent/delivered/opened/replied, cost breakdown, and reply classifications.

List leads (prospects). Filter by campaign or brand. Returns contact details, company info, and outreach status (contacted, delivered, replied, bounced).

List generated emails for a campaign. Returns the subject, body (HTML and text), email sequence steps, and recipient details.

List available workflows. Optionally filter by feature to see workflows for a specific automation type.

Get full details of a workflow including its DAG (directed acyclic graph), nodes, edges, required providers, and version info.

Get a human-readable summary of a workflow — what it does, what steps it takes, and what API providers it requires.

Check if all required API keys are configured for a workflow. Shows which providers are ready and which are missing.

List media outlets discovered for a brand. Shows outlet name, URL, domain, relevance score, outreach status, and associated campaigns.

List outlets discovered for a specific campaign with their relevance scores and outreach status.

List journalists discovered for a brand with enriched data — contact info, outlet, outreach status, email delivery status, and campaign associations.

List journalists discovered for a specific campaign.

List articles discovered for a campaign or brand. Returns article URLs, titles, descriptions, authors, publication dates, and discovery metadata.

List press kits (media kits). Optionally filter by brand or campaign.

Get the full content of a press kit including its MDX page content, status, and metadata.

Generate a new press kit using AI. Provide an instruction describing what kind of press kit you want, and optionally associate it with a brand and/or campaign.

Get view statistics for press kits — total views, unique visitors, and optional grouping by country, media kit, or day.

Check your current credit balance and whether it's depleted.

Get your billing account details — credit balance, auto-reload settings, and payment method status.

List recent billing transactions — credits, deductions, and reloads with amounts and descriptions.

Get a cost breakdown for a brand — shows costs grouped by cost type (e.g. LLM calls, email sends, lead enrichment).

Get total costs grouped by brand across your entire organization.

Get email delivery statistics for a brand — emails sent, delivered, opened, clicked, replied, bounced, and reply classifications.