Skip to main content
API keys let your own systems call SquawkVoice without a person signing in. A key is sent as an X-API-Key header and acts on behalf of whoever created it. You manage keys on the API Keys page in Studio. The page has no sidebar entry, so you open it from a campaign’s On-Demand tab — see Creating a Key.
These are keys your systems use to call into SquawkVoice. They are not the same thing as Auth Profiles, which hold the credentials your AI agents use to call out to your APIs, or the Freshworks keys under Connected Apps.

​
What a Key Can Do Today

An API key is accepted on the On-Demand Call API — placing a campaign call, and cancelling one before it is dialed:
  • POST /api/v1/campaigns/{campaignId}/contacts/on-demand
  • DELETE /api/v1/campaigns/{campaignId}/contacts/on-demand/{contactId}
  • DELETE /api/v1/campaigns/{campaignId}/contacts/on-demand/by-request-id/{requestId}
See On-Demand Calls for the full request and response reference.
The three On-Demand Call API endpoints above are the only customer-facing endpoints that accept an API key. Any other customer endpoint rejects the key with a plain authorization failure (401) — which reads like a broken key rather than an unsupported endpoint. Everything else, including creating and revoking keys, needs a signed-in Studio session.
There is also no key-authenticated way to read results back. Call outcomes live in the Studio.

​
Creating a Key

1

Open the page

Go to Manage → Campaigns and open a campaign. On its On-Demand tab, click API reference, then Manage API Keys. The page is titled API Keys. You can also add /manage/api-keys to your Studio address.Campaigns isn’t in the default sidebar for the Agent Builder role. Add it with Customize sidebar, or press Cmd/Ctrl+K and search for it. API Keys itself has no sidebar or search entry, so it can’t be added or searched for. See Navigating Studio.
2

Click New Key

In the New API Key dialog, give the key a Name — up to 200 characters.
3

Choose an Expiration

No expiration, 1 Year through 5 Years, or Custom with a date picker. The earliest custom date is tomorrow. The latest is one day short of five years from today, which is also the date 5 Years gives you.A key expires at the end of its expiry day (23:59:59 in your browser’s time zone).
4

Click Create Key

The key is only created when you click Create Key. Cancel closes the dialog without making one.
5

Save the key somewhere safe

A Save Your API Key dialog shows the key in full, once, with a copy button: “This is the only time you’ll be able to see this key.” Copy it, then click I’ve Saved It.
Keys look like squawk_sk_live_….
The key value cannot be recovered, and there is no rotate. Only a hash of it is stored, so nothing — not support, not SquawkVoice staff — can show it to you again. Losing a key means revoking it and creating another, then updating whatever was using it.
Name keys for the integration that will use them. The list shows no key value, no prefix and not even the last four characters, so the name you give it is the only way to tell one key from another later.

​
The Key List

Each row shows the key’s name, then Created with a date, Last used with a date (Never until the key is first used), and either Expires with a date or No expiration. A key past its expiry reads Expired with its date and carries an Expired badge. It stays in the list and is rejected at the moment it is used rather than being removed. Search filters by name. Page sizes are 10, 20 and 50.

​
Who Can See and Revoke Which Keys

You see, and can revoke, only the keys you created yourself. A teammate’s keys don’t appear in your list, even inside the same account, and yours don’t appear in theirs. It is worth knowing this before you need it.
You cannot see or revoke a colleague’s key. When someone leaves, delete them from Users. Their keys are deleted with them and stop working on their next request. If the person is staying, or you need a key retired another way, email support@squawkvoice.ai.

​
Revoking a Key

Click the trash icon on a key’s row, then click Revoke in the Revoke API Key? dialog. Revocation is immediate and permanent. Any integration still using that key stops working on its very next request, with no grace period, and the action cannot be undone.

​
Scope and Least Privilege

A key carries the authority of whoever created it. It reaches the campaigns in your account — every campaign, not only the one you were looking at when you made it. A request for a campaign in any other account is refused.
Use one key per integration. Because revocation is immediate and total, a key shared between two systems cannot be retired from one without breaking the other. There is currently no way to restrict who in your account can create keys — any signed-in user can create a key for themselves. If your organization needs that restricted, email support@squawkvoice.ai.

​
Where to go next

On-Demand Calls

The API these keys authenticate, with the full endpoint reference.

Auth Profiles

Credentials your agents use when calling out to your own APIs.