API keys

Under API Keys, administrators create and manage keys to securely connect other programs and their own tools to the RAG service – for example the Windows Syncer, a script, the companyRAG API or the ingestion endpoint of a dataset collection.

The area only appears for companyRAG administrators (see Rights and roles).

The overview shows:

• Name: The freely chosen name of the key (e.g. “Intranet search”), so it can be identified later.
• Created / Last Used: When the key was created and when it was last used.
• Status: Active or Revoked.
• Actions: Revoke blocks the key immediately and irrevocably. All programs using it lose access at once.

Creating a key

1. Select Create New Key.
2. In the Create API Key dialog, enter a Key Name and select Create Key.
3. In the API Key Created dialog, take over the key with Copy and store it in a safe place.

The key starts with rag_ and is shown in full only once, right after it is created. If it is lost, create a new one.

User-scoped access

An API key is bound to the person who created it and acts on their behalf within the RAG administration. All calls are therefore subject to exactly the collections and permissions of that person.

Danger

Do not share API keys with colleagues – every person and every system should create their own key. Otherwise, content may become accessible via the interface that the recipient would not be allowed to see themselves.

All creations and revocations are recorded in the audit logs. The available endpoints are described in the companyRAG API reference.