API Keys

API Keys let an approved external application exchange information with your Versafy workspace—for example, an internal support portal or reporting workflow—without using a teammate’s sign-in. Because a key grants ongoing access, create one only for a known application and owner.

Navigation: Open Misc → API Keys.

The page appears only for users allowed to manage API keys.

Create an API key

Create a separate key for each application and environment so you can identify its purpose and revoke it without interrupting unrelated work.

Select New API key.
Enter a clear name that identifies the application and environment.
Create the key.
Copy it immediately.
Store it in an approved password manager or deployment secret store.

The full secret is shown only once. Versafy cannot display it again later.

Name keys clearly

Use names such as Support portal — production or Reporting export — test. Avoid names that contain passwords, customer details, or the secret itself.

Create separate keys for separate applications and environments. This lets you revoke one integration without interrupting others.

Use keys safely

Never place a key in agent instructions, the Knowledge Base, screenshots, chat messages, or source code committed to a repository.
Never use a browser-side or public website location where visitors can inspect it.
Share it only through an approved secret-management process.
Treat copied logs and error reports as potentially sensitive.

Refer to your organization’s Versafy API reference for request examples and available operations.

Revoke an API key

Select Revoke for the exact key and confirm. Revocation takes effect immediately for applications using it.

If a key may have been exposed, revoke it first, create a replacement, update the external application, and review relevant activity.

Troubleshoot API access

The key was not copied

Revoke the unusable key and create a new one. The original secret cannot be revealed again.

An application loses access

Confirm that its key was not revoked, the correct workspace key is configured, and the requested customer API operation is available to that integration.