Developers

The Developers page in Synthesia Studio brings together your API keys, credit usage, and quickstart links in one place. Use it to get an API key and start building against Synthesia's APIs.

Overview

The Overview tab has:

Developer quickstart: a code sample and a Get started button for the API you're building with.
Usage: your available credits and how much you've used.
Quick links: shortcuts including browsing avatars, building with an agent, libraries and SDKs, pricing, and the changelog.

Create an API key

Select Developers in the sidebar, then the API keys tab.
Select New API key.
Enter a Name for the key.
Choose a Scope (see below).
Choose when the key Expires: in 7 days, 30 days, 90 days, 1 year, or never. The default is 30 days.
Select Create API key.

🚧
Your API key is only shown in full at creation. Copy it and store it somewhere safe—it can't be viewed again afterward.

API key scopes

Each key is scoped to one API surface:

Scope	Works with
`Interactive Avatars`	`developers.synthesia.io/api`
`Legacy (v2)`	`api.synthesia.io/v2`

Use the scope that matches the API you're calling. A Legacy (v2) key won't authenticate against developers.synthesia.io/api, and an Interactive Avatars key won't authenticate against api.synthesia.io/v2.

Managing your keys

The API keys tab lists every key on your account: name, a masked key, scope, expiration, status, and creation date. Search by name to find a specific key.

Select the ⋯ menu next to a key for more actions:

Edit key
Disable
Copy key ID
Delete

📌
Key values can't be viewed again after creation—only the masked version shows here, and Copy key ID copies the key's ID, not its value. If you lose a key, create a new one.