Skip to main content
The public REST API is served at https://api.sendpilot.ai/v1. Its 23 operations use workspace API keys. Dashboard session endpoints are not part of this public contract.
Start by verifying the workspace and effective permissions, then inspect senders and credit balance before performing outreach or paid sourcing. Campaign creation and sequence editing stay in the dashboard. Webhook subscription management is a dashboard/session API, not an undocumented /v1 endpoint.

​
Use the generated contract

Request fields, response shapes, enum values, and limits on endpoint pages come from the controller-generated OpenAPI specification. Its x-sp-scopes and x-sp-costs-credits extensions identify permission and spending requirements. The compatibility copy at /public/schemas/sendpilot.yaml contains the same contract. Read authentication and permissions and limits, pagination, errors, and retries before implementing writes. Use an Idempotency-Key for retryable POST/PATCH requests.

​
REST versus MCP

Do not send MCP fields such as confirm or confirmation_token to REST endpoints. See the MCP guide for assistant setup and approval rules.

​
Webhooks

Workspace webhooks include message.sent, reply.received, connection_request.sent, connection_request.accepted, lead.updated, lead.tag.updated, campaign lifecycle events, and sourcing completion events. See the event catalog and delivery guide for exact names and signature verification.