Private Applications

Private Applications enable your custom AI applications to have all of the visibility, control, and protection of WitnessAI. Just use the WitnessAI APIs to submit the application’s LLM prompts, and receive the LLM responses.

Setting Up a Private Application

Step 1: Create API Key(s)

You can review the WitnessAI Documentation for API Keys here.

Navigate to Administration from the main menu.
Under Configuration, click API Keys.
Enter a Key Name for your key (e.g., "Finance AI").
Choose an Expiration Date for the key.
Click Generate user key.
Use the “Copy” icon to copy your new API key to your clipboard.

A popup message will appear stating the key has been copied to your clipboard. The key value is shown only once, so the Copy icon appears only on a key you generated in this session. Keep the key somewhere safe.

The API Keys page under Administration, with the Key Name and Expiration Date fields, the Generate user key button and a table of existing keys.

Image of pop up message stating “Successfully copied to clipboard”

Step 2: Use the API in Your Application

You can review the WitnessAI API Reference Documentation here.

The “Input” and “Prompt-Protect” API calls are the APIs that initiate the sequence of submitting a prompt to WitnessAI. In these APIs there is an object named caller, containing an application_name field. The application name ties together all of your conversations for that custom application.

Input API excerpt.


Object: caller
	Field: application_name Type: string Example: “My Custom App”
			Description: Application name as displayed in the console.
	Field: application_version Type: string Example: 1.0.1
			Description: Application version.

Create a unique application name to use in all of your application’s API calls to WitnessAI. All of the prompts you submit through the API, and the responses, will appear in your conversations identified by this application name.

Example: If you have a custom AI application for Finance, and use the application_name "Finance AI App", all conversations in WitnessAI will show "Finance AI App" as the application. All alerts will also show "Finance AI App" as the application, and all your policies and guardrails will now have a “Finance AI App” available as a destination.

Step 3: Add the Application to the Private Applications List

The Lists overview table, with Private Applications in the first row.

Navigate to Lists from the main menu.
On the Lists overview table, select Private Applications.
Click Add Application.
In the Add Private Application dialog, enter your application name in the API "application_name" field (e.g., "Finance AI App"). Use exactly the value your code sends.
Click Save. A confirmation reads Finance AI App successfully added, and the application appears in the Private Applications table.

The Add Private Application dialog with the API application_name field and the Cancel and Save buttons.

Step 4: Update Policies to include your Private Application

Once your application is added to the Private Applications list, you can include it in your existing policies, and create new policies.

The Sources & Destinations section of the policy editor, where you add the private application as a destination.

Navigate to Policies.
Select the policy you want to apply (e.g., "PII Protection").
Add your private application as a destination (e.g., "Finance AI App").
Click Save.

All the prompts you submit through the API, and the responses, will now be protected by WitnessAI and available in all standard features. Conversations from your application appear on the Conversations page under its application name, and you can choose that name in the Application filter.

Remove a Private Application

To remove an application you no longer use, open the Private Applications list and click the delete icon in the application's Actions column.