API Overview
Programmatic access to CallMeter's SIP testing platform — trigger tests, monitor probes, and integrate quality gates into your CI/CD pipeline via the REST API.
API Overview
The CallMeter REST API gives you programmatic access to what you can do in the dashboard: create and run SIP tests, monitor probes, retrieve quality metrics, and manage your testing infrastructure. Every endpoint lives under /api/v1/, returns JSON, and is authenticated with a project-scoped API key.
What You Can Do
- Trigger and monitor test runs -- start a test, poll its status, and pull the final quality summary (MOS, jitter, packet loss, ASR) without opening the dashboard.
- List and inspect resources -- read projects, tests, test runs, probes, and registrars programmatically.
- Run probes on demand -- trigger an immediate probe execution outside its regular schedule.
- Gate deployments on call quality -- wire test runs into CI/CD so a regression in voice or video quality blocks a release instead of reaching production.
Getting Started
New to the API? Work through these in order:
- API Quick Start -- create an API key and make your first call in under five minutes
- API Authentication -- key format, scoping, rotation, and security practices
- API Endpoints -- the full endpoint reference: projects, tests, test runs, probes, and registrars
- CI/CD Integration -- trigger-poll-evaluate patterns for GitHub Actions and GitLab CI
Interactive Reference
Prefer to explore live? The interactive API reference lets you try requests directly from your browser with your own API key.
Worker Troubleshooting
Diagnose and resolve common worker issues including connection failures, status problems, test execution errors, resource exhaustion, and token issues.
API Quick Start
Get up and running with the CallMeter REST API in under 5 minutes. Create an API key, make your first call, and explore the interactive reference.