API and CLI Surface

This page is a compact reference. For step-by-step setup, start with Quickstart.

CLI Command Map

Area	Commands	Use when
Status	dispatch status	Check the API target, workspace, selected inbox, and local auth state.
Auth	dispatch auth workspace, dispatch auth inbox, dispatch auth wallet, dispatch auth clear	Connect direct keys, recover wallet-funded access, or clear saved credentials.
Inbox	dispatch inbox create, dispatch inbox ls, dispatch inbox show, dispatch inbox use, dispatch inbox claim --open	Provision, select, and claim inboxes.
Mail	dispatch mail ls, dispatch mail tail, dispatch mail code, dispatch mail link, dispatch mail links, dispatch mail reply, dispatch mail send	Read recent mail, wait for messages, extract codes or links, and send replies.
Memory	dispatch memory write, dispatch memory read	Store and retrieve subject-keyed text through the selected inbox.
Billing	dispatch billing ls, dispatch billing confirm	List entitlements or confirm x402 payments.
Guide	dispatch guide	Print the bundled operator quickstart and command reference.

Common aliases:

• dispatch inbox list -> dispatch inbox ls
• dispatch inbox select -> dispatch inbox use
• dispatch inbox link -> dispatch inbox claim
• dispatch mail list -> dispatch mail ls
• dispatch mail watch -> dispatch mail tail
• dispatch mail otp -> dispatch mail code
• dispatch mail artifacts -> dispatch mail extract
• dispatch billing list -> dispatch billing ls

Key Types

Key	Scope	Typical commands
Workspace key	Workspace and account-level operations	inbox ls, inbox create, billing ls, billing confirm, issuing inbox keys
Inbox key	One inbox’s mail operations	mail ls, mail tail, mail code, mail link, mail reply, mail send
Claim token	One-time web account linking	inbox claim output and setup link flow
Wallet proof	Signed EVM or Solana message proving control of the funding wallet	web wallet sign-in, x402 claim, auth wallet

Treat all keys like passwords.

Public API Areas

Dispatch web and CLI operate against the same backend control plane.

Area	Representative routes
Agent and workspace setup	POST /v1/agent/signup, POST /v1/agent/claim, POST /v1/agent/unclaimed-inboxes, POST /v1/agent/recoverable-inboxes, POST /v1/agent/recover, GET /v1/agent/session
Inbox management	GET /v1/inboxes, POST /v1/inboxes, POST /v1/inboxes/{id}/api-key
Mail access	GET /v1/inboxes/{id}/messages, GET /v1/inboxes/{id}/otp, POST /v1/send
Billing	GET /v1/billing/entitlements, POST /v1/billing/checkout/session, POST /v1/billing/x402/quote, POST /v1/billing/payments/confirm
Webhooks	POST /v1/webhooks/stripe, POST /v1/webhooks/inbound, POST /v1/webhooks/aws/sns
Account support	signup, email verification, password reset, and support request routes

The CLI handles most request formatting for you. Use raw API calls when integrating Dispatch into automation that cannot shell out to the CLI.

Web Surfaces

Surface	Purpose
Setup	Create or sign into an account, verify email, create an inbox, recover with a wallet, or link an existing inbox.
Mail Desk	Read, organize, and reply from a claimed or wallet-recovered inbox.
Billing	See plan, usage, entitlements, and Stripe upgrade actions.
Settings	Inspect workspace and inbox key state for the current session.
Support	Submit billing, privacy, export, abuse, or account lifecycle requests.

Next Reading

• Choose Your Path
• Plans and Usage
• Common Issues