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 x-api-key request header for all API requests: 
curl "https://api.anyformat.ai/workflows/" \
     -H "x-api-key: YOUR_API_KEY"
Our backend normalizes HTTP headers, so any casing will be handled properly as long as the header is a known HTTP header.

​
Public Endpoints

The following endpoints do not require API key authentication:
  • / - API root
  • /health/ - Health check
  • /schema/ - OpenAPI schema
  • /docs/ - Swagger UI documentation

​
Revoking a Key

Generate a new key to automatically revoke the old one.

​
Security Best Practices

  1. Never share your API key - Treat it like a password
  2. Rotate keys periodically - Generate new keys on a regular schedule
  3. Use environment variables - Store keys in environment variables in production
  4. Monitor key usage - Watch for suspicious activity in your account
  5. Never expose in client-side code - API keys should only be used server-side
If you need to generate a new API key or suspect your key has been compromised, visit the settings page in your anyformat app immediately.