Skip to main content

API Keys

API Keys are used to authenticate programmatic access to the RenderDoc API. Manage your keys, set permissions, and monitor usage from this page.

Overview​

API keys allow your applications to interact with RenderDoc without requiring user login. Each key can have specific permissions and usage limits.

Creating an API Key​

  1. Click Create New API Key button
  2. Enter a descriptive name (e.g., "Production Server", "Testing App")
  3. Select permissions:
    • ✅ Generate Documents
    • ✅ Manage Templates
    • ✅ View Analytics
    • ✅ Manage Team
  4. Optionally set expiration date
  5. Click Create Key

⚠️ Important: Copy your API key immediately! You won't be able to see it again for security reasons.

API Key Format​

rd_sk_abc123xyz456...

All API keys use the rd_sk_ prefix followed by a secure random string.

Permissions​

Generate Documents​

  • Generate documents via API
  • Required for document generation operations

Manage Templates​

  • Create, update, delete templates
  • Publish/unpublish templates

View Analytics​

  • Access document generation metrics
  • Generate reports

Manage Team​

  • Invite team members
  • Update roles and permissions

Best Practices​

  • Use descriptive names: Identify keys by purpose or application
  • Rotate regularly: Change keys every 90 days
  • Limit permissions: Grant only necessary permissions
  • Separate keys per environment: Use different keys for dev, staging, production
  • Monitor usage: Check API activity regularly
  • Revoke unused keys: Delete keys no longer in use

Security​

  • Never commit keys to Git: Use environment variables
  • Store securely: Use secret management tools
  • Monitor unauthorized use: Check activity logs
  • Revoke compromised keys: Immediately delete if exposed

Using API Keys​

In Code (Node.js)​

const response = await fetch('https://api.renderdoc.dev/api/v1/documents/generate', {
  headers: {
    'Authorization': 'Bearer rd_sk_abc123...',
    'Content-Type': 'application/json'
  }
});

In Environment Variables​

# .env
RENDERDOC_API_KEY=rd_sk_abc123xyz456...

Monitoring Usage​

Each API key displays:

  • Total requests: Number of API calls made
  • Last used: Timestamp of last usage
  • Status: Active or Revoked

Revoking Keys​

To revoke an API key:

  1. Find the key in the list
  2. Click Revoke button
  3. Confirm revocation
  4. Key becomes invalid immediately

Note: Applications using revoked keys will receive 401 Unauthorized errors.

Rate Limiting​

API keys are subject to rate limits based on your plan:

PlanRequests/minute
Free60
Starter300
Pro1,000
EnterpriseCustom

Need help? Contact [email protected] or check our API Reference