access_key
. This key is unique to your account and is required for all API requests.
What is the Access Key?
Theaccess_key
identifies and authenticates your requests. Think of it as your personal API password. Without it, the API will reject your requests.
Never share your access key publicly or commit it to version control.
How to use the Access Key
You can authenticate your requests in one of the following ways:1. In the Header (Recommended)
Add the access key to theX-Access-Key
HTTP header. This method is secure and works with all HTTP methods.
2. In the Query String (GET requests only)
For GET requests, you can include the key as a query parameter:3. In the JSON Body (POST requests only)
For POST requests, you can also include the key in the request body:Example Requests
Example using curl (Header)Rotating Your Access Key
You can regenerate (rotate) your access key at any time from your dashboard. When you rotate your key:- A new access key is generated immediately.
- Your old key becomes invalid and cannot be used anymore.
Be sure to update your access key in all scripts and environments after rotation.
What happens if the access key is missing or invalid?
If your request doesn’t include a validaccess_key
, you’ll receive a status 401 and a response like this: