Get started
Sandbox
Build and test against the Macaaw API for free: sandbox keys, recipient restrictions, stamped output and data retention.
The sandbox is a free test environment built into the same API: use a mk_test_ key instead of a mk_live_ key and every call behaves like production, with the safeguards below. Any signed-in user can create sandbox keys — no paid plan needed.
What is different#
| Area | Sandbox behaviour |
|---|---|
| Recipients | Documents can only be sent to addresses on your own email domain. If you sign in with a public mail service (Gmail, Outlook, iCloud…), only your exact address is allowed. |
| Output | Every page of every output PDF — signed documents and task results — is stamped “SANDBOX — NOT A VALID DOCUMENT”. |
| Tasks | At most 5 pages of each file are processed. |
| Rate limit | 10 requests per minute per user across all endpoints. |
| Uploads | Up to 25 MB per file. |
| Plan limits | Sandbox calls never count against your monthly agreements, tasks, OCR pages, Office conversions or credits. |
| Retention | Sandbox documents, tasks and their files are deleted after 7 days. |
| Isolation | Objects are flagged "sandbox": true and never appear in live lists, in the website's agreements list or in live webhooks. |
Recipient restriction errors#
Sending to an address outside your domain is refused with 403:
403 Forbidden
{
"type": "permission_error",
"code": "SANDBOX_RECIPIENT",
"detail": "Sandbox documents can only be sent to addresses on your own email domain."
}Webhooks in the sandbox#
Webhook subscriptions are either live or sandbox. Create one with "sandbox": true (or tick Sandbox in the dashboard) to receive events for sandbox documents and tasks.
Going live#
- Make sure your workspace is on a plan with API access (see Pricing).
- Create a live key under Account → Developer.
- Swap the key and create live webhook subscriptions. Nothing else changes — same URLs, same payloads.
Live documents count against the same plan limits as the website: agreements per month, signers per agreement, file size, daily tasks, OCR pages, Office conversions and credits.