For AI Agents
SuperDocs is built to be used by AI agents, not just people. An agent can create an account and get a working API key in a single request, then use the REST API or the MCP server right away. No web sign-up form, no waiting on a human.If you are an agent acting on behalf of a user, confirm with them before you accept the terms and create an account.
0. Check for existing credentials first
If~/.superdocs/agent_credentials.json exists on this machine, a previous agent already created an account. Call GET https://api.superdocs.app/v1/agents/whoami with that api_key and reuse the account — its documents and remaining quota carry over. Sign up fresh only when the project deliberately needs its own separate account.
1. Sign up
curl
mcp_setup block gives you copy-paste commands to connect right away.
Optional body fields: agent_name (a label), operated_by_email (your operator’s email, used only if you hand off later), and model_metadata (free-form details about your model).
2. Use your key
Send the key as a Bearer token on every request, on the REST API or the MCP server.REST
https://api.superdocs.app/mcp (streamable HTTP) with the same Bearer key. In Claude Code, one command connects it:
Claude Code
get_account_status tool anytime to check your remaining operations.
Long generations
For document-scale generations (a whole handbook or long report in one turn), usePOST /v1/chat/async — it returns a job_id immediately and reports progress via GET /v1/jobs/{job_id}. Plain sync /v1/chat hits the platform gateway timeout (~300s) on very long turns. Editing patterns, placement, verification, and billing are covered in the Agent editing playbook.
3. Quota and handing off to a human
Your account is a normal free account: 500 operations per month, the same as a human free account. When you near the cap and want to keep going, hand the account to your human so they can take it over and pay:curl
working_context (a short note on where you are running) so the email is recognizable and does not look like spam. The response includes a short takeover_code (like ABCD-1234).
Show that takeover code to your human, and tell them where to find it if they ask (you can also save it to a file such as ~/.superdocs/takeover-code.txt). We email a one-time link to the address you gave. Your human opens it, signs in, and enters the takeover code, then takes the account over in place, so you keep all your work and your API key keeps working the whole time. They can then upgrade or pay from the app.
The takeover code is a security check: it proves the person adopting the account is really the one running you, so a link that reaches the wrong inbox cannot be used to take the account. Never email the code or post it anywhere public. (If your human already has a SuperDocs account, they sign into that instead.)
You can also just wait: your quota resets at the start of each month.
Fully autonomous with no human who can upgrade for you?
POST https://api.superdocs.app/v1/agents/request-upgrade with your key (optionally a short note). We don’t offer agent-native card payment yet, but we’re gauging demand and will follow up. A human handoff upgrades you immediately; this path is for when there truly is no human.Rules and limits
- Use one account per agent or user. Do not create multiple accounts to get around the free limit.
- Check your status anytime with
GET /v1/agents/whoamior theget_account_statusMCP tool. It tells you how many operations remain so you can hand off before you hit the cap.

