Skip to main content

​
Getting Your API Key

  1. Log in to your Anyformat account
  2. Navigate to the Settings page to generate a new API key and copy it. For security reasons, the API key will only be displayed once.

​
Using Your API Key

Include your API key in the request header: 
curl "https://api.anyformat.ai/workflows/" \
     -H "x-api-key: YOUR_API_KEY"
Our backend is designed to normalize HTTP headers, any casing will be handled properly as long as the header is a known HTTP header.
The /docs/ and /schema/ endpoints do not require API key authentication. Feel free to use them to explore and test the API (authentication will be required for the actual testing).

​
Revoking a Key

Generate a new key to automatically revoke the old one.

​
Security Best Practices

As general best practices, we recommend:
  1. Never share your API key
  2. Rotate keys periodically
  3. Use environment variables to store keys in production environments
  4. Monitor key usage for suspicious activity
Keep your API key secure and never expose it in client-side code. If you need to generate a new API key, visit the settings page in your Anyformat app.