Skip to main content
Connect, Disconnect, and Toggle require an authenticated session (workspace owner or admin) — they’re designed for the AI Suite web app’s settings UI, not machine-to-machine API key access. List works with either a session or an API key.

List Connectors

object[]

Connect

Starts an OAuth flow for the connector. Redirect the user to the returned authorizeUrl; after they approve, the provider redirects to AI Suite’s OAuth callback, which completes the connection and redirects the user to returnTo.
string
Where to send the user after the OAuth flow completes. Defaults to the workspace’s agent settings page. Unsafe/external paths are ignored.
string
Redirect the user’s browser here to start OAuth.
Tokens are never returned to the client — they’re exchanged server-side and stored encrypted. On completion, the user lands back on returnTo with ?connected={connectorId} appended so your UI can refresh.

Disconnect

Revokes the stored OAuth tokens and marks the connector disconnected. Idempotent.

Enable / Disable

Toggles whether a connected connector is available to agents, without revoking its tokens — useful for temporarily pausing access.
boolean
required

Errors