PlanMySaaS API — Overview
The PlanMySaaS API gives developers the same blueprint pipeline that powers the web app — exposed as a versioned REST API and as an MCP server for AI IDEs (Claude Desktop, Cursor, Windsurf, Claude Code).
Every call costs credits from your workspace balance. Your 100 signup credits work across web + API — there's no developer tax.
Quick start
- Generate an API key at Settings → API Keys.
- Paste it into the
X-API-Keyheader (orAuthorization: Bearer <key>). - POST to any endpoint under
/api/v1/mcp/generate/*with a JSON body containingidea.
First call
curl -X POST https://www.planmysaas.com/api/v1/mcp/generate/research \
-H "X-API-Key: pms_live_…" \
-H "Content-Type: application/json" \
-d '{"idea":"A quiet-hours SMS scheduler for solo SaaS founders"}'Response shape:
{
"data": { /* structured output for the tool */ },
"meta": {
"tool": "generate_research",
"creditsCharged": 25,
"creditsRemaining": 475,
"durationMs": 8234,
"requestId": "a1b2c3…"
}
}Base URL
https://www.planmysaas.com/api/v1The /v1 prefix means this surface is stable — breaking changes ship as /v2 with a deprecation window of at least 90 days.
Request envelope
All generation endpoints accept POST requests with JSON. The only required field is idea (10-2000 chars). Optional upstream artefacts can be passed to improve output coherence:
research— pass to/generate/architectureso tech choices factor in market contextarchitecture— pass to/generate/featuresfor feature specs that respect your system designfeatures— pass to/generate/phasesto sequence real features into real phases
Response envelope
Every response follows one of two shapes:
Success (2xx)
{ "data": { ... tool-specific output ... },
"meta": { "tool", "creditsCharged", "creditsRemaining", "durationMs", "requestId" } }Error (4xx / 5xx)
{ "error": {
"code": "insufficient_credits", // machine-readable
"message": "You need 150 credits but have 40.",
"docs": "https://www.planmysaas.com/docs/api/errors",
"requestId": "a1b2c3…"
}}Tools available
| Tool | Endpoint | Credits | Plan |
|---|---|---|---|
| Research | POST /generate/research | 25 | Free+ |
| Architecture | POST /generate/architecture | 20 | Free+ |
| Features | POST /generate/features | 25 | Free+ |
| Phases | POST /generate/phases | 15 | Free+ |
| Prompt Pack | POST /generate/prompt-pack | 30 | Starter+ |
| Full Blueprint | POST /generate/blueprint | 150 | Starter+ |
| Check Credits | GET /credits | 0 | Free+ |
Next steps
- Authentication — API keys, headers, revocation
- Endpoints reference — every tool with curl + TS + Python examples
- Rate limits — 60 req/min per key, quotas
- Error codes — every failure path, when to retry
- MCP install — Claude Desktop