Skip to main content
For AI agents: a documentation index is at /llms.txt. Every page is also available as markdown, just append .md to the URL.

​
API Key Authentication

The Reap Automation API uses API key authentication. You’ll need to include your API key in the Authorization header of every request.

​
Getting Your API Key

  1. Log in to your Reap dashboard
  2. Click API Keys in the left sidebar. You can also open your avatar menu in the top right and go to Settings > API Keys.
  3. Click Create a Secret Key
  4. Give your key a descriptive name. This is only for your reference.
  5. Optionally, set an expiration date for the key. Keys are not expired by default.
  6. Click Create Key to generate the API key.
  7. Copy the generated API key (store it securely - you won’t be able to see it again)
Keep your API key secure! Don’t commit it to version control or share it publicly. Store it in environment variables or a secure configuration management system.

​
Making Authenticated Requests

Include your API key in the Authorization header with the Bearer prefix:

​
Authentication Headers

​
API Key Management

​
Security Best Practices

Environment Variables

Store your API key in environment variables rather than hardcoding it in your application.

Regular Rotation

Rotate your API keys regularly for enhanced security.

Least Privilege

Use separate API keys for different environments (development, staging, production).

Monitor Usage

Monitor your API key usage to detect any unauthorized access.

​
Key Expiration

API keys do not expire by default. You can:
  • Set custom expiration dates when creating keys
  • Create non-expiring keys (recommended for production)
  • Monitor expiration dates in your dashboard
  • Revoke keys at any time

​
Revoking API Keys

To revoke an API key:
  1. Click API Keys in the left sidebar of your dashboard
  2. Find the key you want to revoke
  3. Click the trash icon next to the key
Revoking an API key immediately invalidates all requests using that key. Make sure to update your applications before revoking keys.

​
Rate Limiting

Rate limits apply per endpoint, per API key. Each endpoint keeps its own budget, so draining get-project-status leaves create-clips untouched. Exceeding a budget returns 429 Too Many Requests:

​
Rate Limit Headers

Treat X-RateLimit-Remaining as advisory. Counters are tracked per API server process, so consecutive requests can report slightly different values and the number can go up as well as down. On a 429, Retry-After is the value to back off on.

​
Error Responses

​
Authentication Errors

​
Example Error Response

​
Testing Authentication

Test your API key with a simple request to get your presets:
A successful response indicates your authentication is working correctly.