Getting Started
Authentication
Authenticate API requests
Protected operations accept an API key in this HTTP header:
Code
Request a free API key if you need one.
Authorize a playground request
- Open an operation in the API reference.
- Open the Authorize control and enter your API key.
- Add the operation parameters, then select Send.
- Clear the credential when you finish, especially on a shared device.
Send the key from your application
Keep the key out of source code by storing it in an environment variable:
Code
Then pass it in the bearer header:
Code
The official Python and TypeScript clients use the same bearer contract through their client configuration.
Protect the key
Treat an API key like a password. Do not commit it, place it in a URL, or include it in a public browser application. Use environment variables or your deployment platform's secret storage, and add the header from server-side code.
If the API returns 401, confirm that the key is current and the header starts
with Bearer , including the space. Clear and re-enter the key in the
playground if needed.
Last modified on

