Email API reference for AI agents

Authenticate before making requests

Create a workspace, then generate an account key in the console’s API keys view. Use account keys for mailbox provisioning and workspace management. Give an agent only the mailbox-scoped read/send key it needs. Keys belong in an Authorization header on your server, never in a URL or public client.

curl 'https://cyberpigeon.ai/v1/me' \
  -H 'Authorization: Bearer YOUR_API_KEY'

New accounts can send right after signup. Custom domains need their own DNS verification. An accepted send returns 202 for queued mail, not confirmed delivery. Save an Idempotency-Key for each send, and poll message history or GET /v1/events with a persisted cursor for the outcome. Signed incoming-email wake-ups are available after hosted delivery is activated; delivery-status events still use polling.

The current beta supports permitted testing, expected transactional mail and support replies. Cold outreach, sales prospecting, bulk marketing, inbox warmup and spam are prohibited. Read the terms and acceptable use; Cyberpigeon Outbound is a separate product in development.

Browse the REST endpoints

This endpoint index is available without JavaScript. The OpenAPI specification contains request parameters and schemas for tools and client generators. Use the documentation index to find the explanatory guides. Administration operations require the deployment administrator key and are not account-signup endpoints.