1. 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 for the API key
Feel free to name your API key anything you like.
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, JS 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.
2. 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.3. 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.