Documentation
1. What is Portal?
Portal is an autonomous service signup API for AI agents. Instead of a human manually creating accounts on services like Resend, Railway, or Vercel, agents can call Portal's API and get credentials back automatically.
All endpoints are protected by x402 micropayments — pay per signup with USDC on Base. No API keys, no subscriptions, no monthly minimums.
2. Installation
MCP Server (Recommended)
Add Portal to your agent's MCP configuration:
{
"mcpServers": {
"portal": {
"command": "npx",
"args": ["@getportal/mcp"]
}
}
}
Or run directly:
npx @getportal/mcp
Direct API
For non-MCP agents, call the API directly with x402 payment headers.
3. Wallet Setup
Portal accepts USDC payments on Base (eip155:8453). You'll need a wallet with USDC to pay for signups.
- Create a wallet (Coinbase, MetaMask, or any EVM wallet)
- Bridge USDC to Base network
- Fund the wallet with a few dollars (signups cost $0.50–$1.00)
💡 Tip: The MCP server will generate a wallet at ~/.portal/wallet.json on first run. Deposit USDC to that address.
4. Supported Services
| Service | Price | Time | Returns |
|---|---|---|---|
| Resend | $0.50 | ~20s | API key |
| Railway | $0.50 | ~25s | API key |
| Vercel | $1.00 | ~30s | API key |
| Supabase | $1.00 | ~35s | API key |
| Cloudflare | $1.00 | ~30s | API key |
5. API Usage
Create Signup
POST /signup
Content-Type: application/json
X-PAYMENT: <x402 payment>
{
"service": "resend",
"email_mode": "portal_managed"
}
Check Status
GET /jobs/portal_abc123_xyz789
Get Credentials
GET /credentials/portal_abc123_xyz789
⚠️ Important: Credentials are one-time retrieval. They're deleted immediately after you access them and expire 5 minutes after job completion.
6. Email Modes
- portal_managed (default): Portal generates a unique email address and handles verification
- agent_provided: You provide the email; Portal will send verification to it (you handle the click)
7. Security
- Credentials encrypted at rest
- One-time retrieval (deleted after access)
- 5-minute expiration window
- No credential logging or storage after retrieval
- Payment = authentication (no API keys to manage)
8. Full API Reference
See /llms.txt for complete API documentation in a machine-readable format.