REST API
Overview
REST API overview, base URL, and quick start
The REST API exposes the same tools available in the CLI and MCP server as authenticated HTTP endpoints.
The API server is available on the saas branch. The main branch includes the CLI and MCP server only.
Base URL
Production:
https://api.gmailmcp.comLocal development:
http://localhost:8000The API shares one process with the MCP server, so the production host also
answers at gmailmcp.com / mcp.gmailmcp.com; api.gmailmcp.com is the
canonical vanity host for REST traffic. The examples below use localhost;
swap in the production base URL to call the deployed API.
Quick Example
curl -X POST http://localhost:8000/api/v1/services/greet \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{"name": "Alice", "shout": true}'{ "message": "HELLO, ALICE!", "times": 1 }Health Check
No authentication required.
curl http://localhost:8000/health{
"status": "ok",
"version": "0.1.1",
"commit": "a1b2c3d",
"timestamp": "2025-01-15T10:30:00+00:00",
"components": {
"api": { "status": "ok" },
"database": { "status": "ok" },
"redis": { "status": "not_configured" },
"stripe": { "status": "ok" }
}
}Status is "ok" when all components are healthy, "degraded" if any have errors.