Skip to main content
Keys authenticate https://api.synapsai.cloud. Manage them at API keys. Creation requires an account that accepted the Terms and Privacy Policy. API use also follows the Data Policy and Acceptable Use Policy. GDPR/UK personal data in workloads is covered by the DPA.

​
Create a key

1

Open API keys

Click Create Secret Key.
2

Name and permissions

Restrict the key. Prefer specific model ids over all models.
3

Copy once

Click Create Key and store the value. It is not shown again.
Treat the key like a password. Never put it in frontend bundles or public repos.

​
Permissions

Empty model scope on old keys may still mean all models. Vector stores is a separate grant — it is not implied by model access. The dashboard also mints short-lived playground and upload keys. Those are for the UI; production apps should use a permanent secret you created here.

​
Edit, refresh, delete

  • Edit Key — change name and permissions.
  • Refresh Key — invalidates the secret and issues a new one. Rotate about every 90 days, and immediately if leaked.
  • Delete Key — irreversible. Create a new key to call the API again.

​
Next steps

Call the API · Integrations · Security