Quick start
1. Create an API key
- Log in to Benchmark Email as an account owner.
- Go to Settings > API Keys.
- Click Create API Key.
- Give it a name (e.g., “My Integration”) and select the permissions you need.
- Copy the key immediately — it will only be shown once.
2. Copy your base URL
Your base URL depends on the region and cluster your account is provisioned in. It looks like this:https://api-{region}-{cluster}.benchmarkemail.io
For example: https://api-us-west-2-a.benchmarkemail.io
Find your base URL in Account Settings > API Keys and use it wherever you see <your-api-base-url> in the examples on this site.
3. Make your first request
Copy your API base URL from Account Settings > API Keys and use it in place of<your-api-base-url>:
401 or 403 error, see the errors guide for troubleshooting.
API reference
Available resources
Scenario guides
For step-by-step walkthroughs of common workflows, see the scenario guides.Building with an AI assistant?
If you’re using an AI coding assistant, give it these resources before you start:- llms.txt: sitemap-style index of every documentation page
- llms-full.txt: full text of every documentation page in one file
- SKILL.md: agent-specific playbook with endpoints, decision guidance, and common pitfalls