Skip to main content
API keys serve as authentication tokens for accessing the SynapsAI Cloud API. They enable you to control access to your deployed models. Each model deployment is restricted to API keys created under your account or team.
API key creation requires an account that has accepted the Terms of Use and Privacy Policy at registration. All API use is governed by those agreements, the Data Policy, and the Acceptable Use Policy. If your workloads contain personal data regulated by the GDPR or UK law, the Data Processing Agreement applies automatically.

​
Creating an API key

1

Create an API key

To create an API key, go to the API keys page in the SynapsAI Cloud platform and click the “Create Secret Key” button.
2

Choose a name and permissions for the API key

Feel free to name your API key anything you like. You can also set permissions on the API key to control which models it can access. We do not recommend giving an API Key access to all models.
3

Generate the API key

Click the “Create Key” button to create the API key.
4

Copy the API key

Copy the API key and store it securely. You will not be able to see it again. You will need to use this key to authenticate your requests to the SynapsAI Cloud API. This can be done via the Python client or curl requests.
Treat your API key like a password. Do not share it with others as they provide direct access to deployed models.

​
Editing an API key

Editing an API key allows you to change the permissions of the API key. To edit an API key, go to the API keys page in the SynapsAI Cloud platform and click the “Edit Key” button next to the API key you want to edit in the Actions column.

​
Refreshing an API key

Refreshing an API key invalidates the old key and creates a new one. This is useful if you need to rotate your API key for security reasons. We recommend refreshing your API key every 90 days. To refresh an API key, go to the API keys page in the SynapsAI Cloud platform and click the “Refresh Key” button next to the API key you want to refresh in the Actions column.

​
Deleting an API key

Deleting an API key invalidates the key and removes it from your account. This is useful if you no longer need the API key or if you have rotated your API key. To delete an API key, go to the API keys page in the SynapsAI Cloud platform and click the “Delete Key” button next to the API key you want to delete in the Actions column.
Deleting or refreshing an API key is irreversible. You will need to create a new API key if you need to access the SynapsAI Cloud API.
If one of your API keys is compromised, refresh it immediately.