Create an API key
Sign in to the Syntic Console, select the organization that should pay for the usage, open API Keys and choose Create API Key. Copy the key the moment it appears: Syntic shows the full key only once.
Before you start
- You need a paid plan. Organizations on the Free plan can’t create API keys. The server answers “Your account is a free one. Please upgrade to use the Syntic API.” See Compare plans.
- You need the right role. Owners, administrators and developers of an organization can create keys. Other roles get “Your role cannot create API keys. Ask an organization admin.”
- Pick the right organization. The key is tied to the organization selected in the breadcrumb. All its usage is billed there.
Create the key
Open API Keys
Go to platform.syntic.ai, sign in, and choose API Keys under Organization in the left menu.
Choose Create API Key
The button is at the top right of the API Key Management page.
Name it
In Name, enter something that says where the key will live, such as “Production server” or “staging-worker”. Up to 64 characters.
Choose the type
Under Type, keep Private — server-side (sk_live_…) for calling Syntic models from your own code. Choose Public — client-side SDK (pk_live_…) only if you specifically need a browser key; public keys can’t call the models API. See Private and public keys.
Create
Choose Create Key.
Copy and store the key
The dialog changes to API Key Created and shows the full key. Click the copy icon (you’ll see “Copied to clipboard”), paste it into your password manager or your server’s secret store, then choose Done.
After you close the dialog, only the first few characters are ever shown again. Syntic keeps a one-way fingerprint of the key, not the key itself, so nobody (including support) can recover it. If you lose it, revoke it and create a new one.
If you use two-step verification
When your account has two-step verification turned on, or your organization requires it, Syntic only creates keys from a session where you have entered your second-factor code. In the Console that is always the case, because the Console asks for the code at every sign-in.
Creating a key in the main Syntic app
You can also create keys in the main Syntic app under Settings → API Keys: choose Generate Key in the Private API Keys or Public API Keys section. Keys made there appear in the Console and the other way round.
If creation fails
The Console shows “Couldn’t create the API key.” Common causes:
| Cause | Fix |
|---|---|
| Free plan, or billing not active | Upgrade, or update your payment method |
| Your role can’t create keys | Ask an owner or administrator |
| You already have 20 active keys in this organization | Revoke one you no longer use |
| The organization already has 100 active keys | Ask an admin to revoke unused keys |
| An allowed origin isn’t valid | Use the form https://app.example.com |
More in Key limits and who can create keys.