Skip to main content

​
Request Header

Include the following header in all API requests:
Example:

​
Generating an API Token

You can generate a unique API token from your account settings. Steps:
  1. Log in to your FalconFeeds Dashboard
  2. Navigate to Settings → API Access
  3. Click Generate New Key
Your API token can be revoked at any point. Revoking a token will immediately invalidate all requests using that token.

​
Token Expiry

When creating an API token, you can configure its expiry:
API requests made with an expired token will fail with a 401 Unauthenticated response code.

​
Masked Images

Each API token has a Mask images toggle available in Settings → API Access. When enabled, images returned through that token’s API responses will be masked - redacting personally identifiable information (PII) in screenshots while still returning the processed image. This setting is configured per token, so different tokens can have different masking behaviour - useful when sharing access across teams with varying clearance levels.