Skip to main content
Initialize once.

Initialize

Email

Complete sending-domain setup before these sends.
from_domain must be a domain you bought or connected, and from_mailbox one of its addresses (default: its main address). from_name is the display name recipients see; omit it to send from the bare address.
Mailboxes or addresses: the domain purchase picks the mode and names the addresses. quoteDomain(name, { mailbox_mode: "mailbox", addresses: ["jane"] }) gives each address a hosted inbox, warmed before it sends, with a one-time mailbox_provisioning_fee per address on the quote. The default relay addresses send and receive with no inbox, free. The mode is fixed once bought: a different one on a later quote returns 409 mailbox_mode_conflict. An address the domain lacks makes email() return confirmation_required with the quote that adds it; nothing is sent.

Bulk email

The SDK handles bulk quoting. Service fees scale with the number of recipients.

Voice calls

SMS

Deep research

Poll inbox

People search and enrichment

seniority takes any of owner, founder, c_suite, partner, vp, head, director, manager, senior, entry, intern. Common variants ("Vice President", "C-Level", "executive") are accepted, and a value that matches no level fails the search with invalid_input. industry is free text. An empty results array means the search ran and nobody matched. If the search could not be run, the call throws a JobError with a retryable code (service_unavailable, service_auth, rate_limited) instead of returning an empty result.

Find and verify email

Commerce: search and buy

Search the web and get structured results synchronously, without polling:

Web read

Read a web page as markdown, with a screenshot:

Browser automation

Person intelligence

Look up a person by name+company, email, phone or profile URL. Each method runs async and returns when the job finishes.

Universal tool method

Get balance

The agent.usdcAddress getter returns the USDC contract address on Base Mainnet: 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913.

Spend budgets

Cap the agent’s spend per day and per call. The API enforces the cap, so it survives restarts and applies across every process using this wallet:

Error handling

Build production websites

Update existing website

Complete agent example

Next steps

API Reference

API reference

SDK Source

SDK source

Optional phone lookup

waitForPhones waits without purchasing phones. onStatusUpdate('completed', requestId) fires after this wait, before resolution; phones_pending: true may remain on timeout.