Authentication
The Polygot API is protected by API keys. Using one of your API keys in your requests will authenticate you to Polygot.
Your API keys must remain private and must not be disclosed, at the risk that they could be used without your knowledge by a malicious person.
Create an API key
- Navigate to your Polygot account settings page
- Under the "API keys" section, click the "New API key" button
- Type a name for your API key (this name allows you to identify the key, choose it carefully)
- Click the "Create" button
- Save the generated key as you will no longer be able to see it in full afterwards, for security reasons
Use an API key
To authenticate yourself using an API key, add an x-api-key header to your requests, with your key as the value.
curl -XGET -H 'x-api-key: <YOUR_KEY>' 'https://api.polygothq.com/users/me'
Delete an API key
If you don't need an API key, it is advisable to delete it to prevent it from being used without your knowledge.
- Navigate to your Polygot account settings page
- Under the "API keys" section, find the key you want to delete and click the associated "Delete" button
Table of Contents