Ctrlk
ChangelogTry UPTIQ AI
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Keys

API keys provide programmatic access to the platform. Open Admin → API Keys.

This page covers one of three key types. The account-wide platform key you create here (sent as x-platform-key) is not accepted by agent runtime routes. To call a specific agent, use the agent key (x-api-key plus its secret) or the widget key (x-widget-key plus a whitelisted domain), both issued from that agent's own Deploy tab — see Integrate Agent. Older projects may still carry a legacy project key, which continues to work. None of the four key types expire or support rotation today. To stop a platform key from being used, revoke it.

Search by name or key ID. Each key shows how many permissions it carries, for example 1 permission, and an Actions menu. Select + Create API Key to issue a key.

Create an API key

+ Create API Key opens a dialog that asks you to grant the key only the permissions it needs.

  • Key name — a label, such as Reporting integration.

  • Select Permissions — required. Search the list and check each permission the key needs.

The Create API Key dialog: a Key name field with the placeholder e.g. Reporting integration, a Select Permissions list with a Search permissions field and checkboxes such as Create a project, View user, Create user, Manage user, View App, Build your own app from chat and Build app from IDE, and Cancel and Create Key buttons
Name the key and check the permissions it needs.

The permissions are the account's capabilities: the same set that roles carry, such as Create a project, View user, and Manage user. For what each capability covers and which roles hold it, see Capabilities by role.

Select Create Key to issue the key. The button stays unavailable until you enter a name and select a permission.

Copy the key

When the key is created, the dialog shows Your key has been generated. Copy the key now: for security, it's shown only once and can't be retrieved later. Select the copy icon beside the key.

Below it, Example — API Key Usage shows a sample curl request that sends the key in the x-platform-key header. Select Done to close the dialog.

The Create API Key dialog after creation: a Your key has been generated panel with the key hidden and a copy icon, the warning that the key is shown only once and cannot be retrieved later, an Example — API Key Usage curl request with an x-platform-key header, and a Done button
The new key, shown once, with a sample request.

API keys can carry account-management permissions. Grant only required permissions. Store the key value securely.

Manage a key

Each key's Actions menu has two options:

  • Sample cURL — show a sample curl request for the key, with a <YOUR_API_KEY> placeholder in the x-platform-key header. Replace the placeholder with the key you copied when you created it.

  • Revoke — revoke the key.

A key's Actions menu open, showing Sample cURL and Revoke, next to the refresh and Create API Key buttons
Each key's Actions menu.
The Sample cURL dialog, with an Example — API Key Usage curl GET request whose x-platform-key header holds the placeholder YOUR_API_KEY, and a Done button
The sample request, with a placeholder where your key goes.

Maintained by Abhishek Paul AI-assisted, human-approved

PreviousRoles
NextAdmin: FAQs & Troubleshooting

Last updated

Was this helpful?