Get started with the Syntic API
To call the Syntic API you need a Syntic account, an organization on a paid plan, and a private API key from the Syntic Console. There is no separate developer sign-up.
Before you start
| You need | Why |
|---|---|
| A Syntic account | The Console uses the same account as the rest of Syntic. See Create an account |
| A paid plan on the organization | The Free plan can’t create keys or call the API. See Compare plans |
| The Owner, Administrator or Developer role | Other roles can’t create keys. See Key limits and who can create keys |
First run
Sign in to the Console
Go to platform.syntic.ai and sign in with Google or an email code. See Sign in to the Console.
Select the organization that should pay
Use the breadcrumb at the top left. Keys, usage and credit belong to the organization that is selected. See Switch organizations and projects.
Create a private key
Open API Keys and create a key. Copy it straight away and store it somewhere safe. See Create an API key.
Send one test request
Follow Make your first API request, or the developer Quickstart for code in your language.
The Console’s Playground isn’t connected to live models yet, so test with a real request instead.
If it doesn’t work
Look up the status code in Troubleshoot the Syntic API.