API Keys

You can also create keys programmatically:

curl -X POST https://api.paperjsx.com/api/dashboard/api-keys \
  -H "Content-Type: application/json" \
  -H "Cookie: <session>" \
  -d '{ "name": "CI Pipeline" }'

Using Keys in Requests

Pass the key as a Bearer token or via the x-api-key header:

# Bearer token (recommended)
curl -H "Authorization: Bearer pj_live_YOUR_KEY" \
  https://api.paperjsx.com/api/v2/render ...

# x-api-key header
curl -H "x-api-key: pj_live_YOUR_KEY" \
  https://api.paperjsx.com/api/v2/render ...

Naming Conventions

Give each key a name that identifies its environment or system:

• Production -- your live application
• Staging -- pre-production testing
• CI Pipeline -- automated builds
• MCP Server -- Claude Desktop / Cursor integration

The key table shows the name, a truncated prefix, status, and last-used date so you can audit which keys are active.

Revoking a Key

Click the trash icon next to any active key to revoke it. Revoked keys stop working immediately -- any client using the key will receive a 401 Unauthorized response. Revocation is permanent; create a new key if you need to restore access.

Permissions

Only users with owner or admin roles can create or revoke API keys. Members can view the key list but cannot modify it. See Access for the full permission matrix.

Usage Limits

API keys inherit the organization's plan limits. On the free tier, keys are subject to a per-period request cap enforced at validation time. When the limit is exceeded, the API returns 429 Too Many Requests with error code ERR_USAGE_LIMIT_EXCEEDED. Paid tiers allow overage at the per-document rate.

Next Steps

• Quick Start -- use your key to make a first render
• Authentication -- session vs. API key authentication
• Usage -- monitor how your keys are consuming render capacity