API reference

Service status and version

Sign-in, sessions, “View as” mode, password change and reset, accepting invitations

User accounts of the organization

API keys of the organization

OAuth apps of the organization and employee authorizations

The OAuth 2.0 protocol: consent screen, token issuance and revocation, authorization server metadata

Audit log of the organization

The organization, its logo and data export

Document categories

Knowledge collections

Knowledge cards: upload, content, tables, versions, verification, comments

Indexing queue: jobs, parse preview, change stream (SSE)

Conversations with the assistant

Search and assistant answers, including the SSE stream

Requests for access to the sources of a hidden answer

Question log, suggestions, answer exports, live answer

Export files

Insights: summary, duplicates, knowledge gaps and knowledge health

Tasks of a user and of a team

Data sources, such as Google Drive and Confluence

Access model: the permission registry and permissions on the organization, collections, cards and sources, both granted directly and inherited

Roles: named sets of permissions, built-in and custom

User groups: regular groups, “All members”, role groups and personal groups

Collection folders: a tree up to three levels deep, ordering relative to a sibling, one card in several folders, inherited permissions

Catalog of external services (SaaS and vendors) with names, websites, categories, icons and descriptions, and links between your organization's names and catalog entries

Drafts and publication approval

Verification: status, due dates, verifiers, history, the “verify first” queue, Trust Score and offboarding

Must-read announcements: audience, read confirmation, reports, reminders, export

Threaded card comments with an anchor and a status, and reactions

Organization webhooks: endpoints, event subscriptions, signatures, deliveries and retries

Public API for integrations: the machine-readable specification of this API

Multipart uploads of large files: the session, the parts, completion with checks, and use by a card, an archive or an import

Product analytics: usage events, per-object counters, the health, usage and contribution dashboards, the renewal report and exports

Answer quality: questions without a good answer and the knowledge gaps taken into work

Financial documents: exchange rates and the counterparty directory