REST API & SDKs — Docs

REST API & SDKs — Everything in the product, from your own code. Python and TypeScript SDKs.

Provides
Knowledge source	✓
Agent tools	✓
Channel	✓

Setup

Go to Settings → Integrations → REST API & SDKs → Connect.
Authorise with an account that has access to everything you want to make available. For knowledge sources, use an admin or service account; permissions are still enforced per user at query time.
Add REST API & SDKs as a source under Knowledge → (knowledge base) → Add source and choose the scope to include.

What is synced

Content from the scope you select, with its metadata (author, dates, location) and the access rights defined in REST API & SDKs. Changes are picked up by change notifications where REST API & SDKs supports them, otherwise on the schedule you set (15 minutes to daily). Deletions and permission changes are applied on the next sync.

Permissions

Access rights in REST API & SDKs are mapped to workspace users (by email) and groups. A user can only retrieve items they could open in REST API & SDKs itself. See Permissions & access control.

Tools

Tool	Scope	Purpose
`rest_api_sdks.read`	read	Read records, messages or files in scope
`rest_api_sdks.search`	read	Search within REST API & SDKs
`rest_api_sdks.write`	write	Create or update items; subject to approval policies

Write tools require approval by default until an approval policy says otherwise. Every call is recorded in the run trace.

As a channel

Users can ask questions and receive agent results in REST API & SDKs; approvals can be answered there too. See Platform access.

Triggers

Events from REST API & SDKs (new or updated items in scope) can start agent runs. See Automations & triggers.

Disconnecting

Disconnecting removes the credential from the vault immediately. Documents synced from REST API & SDKs are removed from knowledge bases within minutes and from backups as they rotate.