Skip to main content
There are two ways to control who sees a knowledge item:
  1. Exclusive scope — the assistant_id field, set on creation or on update. It links the item to a single assistant.
  2. Exclusions — for global items, a list of assistants that should not see that knowledge item. That is what this page covers.
Use exclusions when the material is meant for almost every assistant. Use assistant_id when it is meant for a single one.
Exclusions only apply to global knowledge items. If the item already has assistant_id filled in, the endpoints below return 409. Make it global first by sending {"assistant_id": ""} on update.

Remove an assistant’s access

Adds the assistant to the exclusion list. The operation is idempotent: repeating the call does not raise an error.

Path Parameters

string
required
Knowledge item UUID (it must be global)
string
required
UUID of the assistant that will stop seeing the knowledge item
Returns 200 OK with the updated knowledge item.

Give an assistant its access back

Removes the assistant from the exclusion list — it can see the knowledge item again.

Path Parameters

string
required
Knowledge item UUID
string
required
UUID of the assistant that will see the knowledge item again
Returns 200 OK with the updated knowledge item.

Set the full exclusion list

Replaces the whole list at once. Useful to sync the assignment from an external system, without having to compute what was added and what was removed.

Path Parameters

string
required
Knowledge item UUID

Body

array
required
List of UUIDs of the assistants that must not see the knowledge item. Send [] to grant access to everyone.
Returns 200 OK with the updated knowledge item.

Grant access to everyone

cURL

Errors