API Key is your gateway to securely integrating AI capabilities into your own applications and workflows. This section is designed to help developers quickly enable API access, understand available endpoints, and begin building with confidence. Whether you want to interact with specific AI models, leverage custom vector vaults, or automate advanced use cases, the API provides a secure and scalable foundation. By enabling API access and exploring our documentation, you can unlock powerful, privacy-first AI solutions tailored to your organization’s needs.

<aside> 💡

Important: Enabling and using API keys incurs additional cost. Please review pricing details before activation.

</aside>

Access API Documentation

The API Key feature allows users to generate and manage API keys to securely integrate external systems, applications, or scripts with the Prompt Privacy platform. View the documentation on how to use your API Key and integrate it with an external system.

<aside>

Developer Resources

</aside>

Who Can Access API Key

API Keys is available to users with the required permissions in your role. If you do not see this option, contact your Tenant Manager.

How to Generate API Key

Follow the steps below to generate your API key:

• Go to Profile — ****From the main chat interface, click on your name in the left-hand menu and go to Profile.
• Navigate to API Key — In the left menu, select API Key.
• Generate API Key — Add a name for your API Key and click Generate Key. Your API key will be generated and displayed.
• Once generated, the following information will be displayed:
  • API Key — A unique, secure key used to authenticate API requests made from your applications or scripts.
  • Tenant ID — A unique identifier representing your organization within the Prompt Privacy platform.
• You can perform the following actions:
  • Copy — Copy the API Key or Tenant ID for use in your integrations.
  • Regenerate — Create a new API Key if the current key is compromised or needs to be rotated.

Note: Make sure to copy and securely store your API key immediately.

Important Note