API Reference

Chat API

The Chat API is where every integration starts. It signs users in and issues the access token that the other VDF AI APIs accept, and it holds the conversational layer of the platform: chat sessions and their messages, the documents people upload, and user profiles.

It is also where third-party systems are connected. Integrations such as Jira, Confluence, GitHub, and Microsoft 365 are authorised and synchronised here, and their content is indexed into the knowledge your agents search. Network triggers, which start a network when something happens in a connected system, live here too.

Administrators use the Chat API to run the deployment: users and groups, directory synchronisation and single sign-on, backups, company details, platform settings, and licence usage.

Path prefix/api
AuthenticationBearer access token
FormatJSON over HTTPS
Endpoints131
Routes167

Resources

Documents

Upload files to your document library, list them, extract their text, download, and delete.

Profile

Read and update the signed-in user's own profile, password, avatar, and company details.

Jira

Connect Jira, browse projects, boards and issues, create and update issues, and manage event webhooks.

GitHub

Connect a GitHub account with a personal access token and list the repositories it can reach.

AdministrationEndpoints for the administrators of your deployment.

Users

Create, list, update and deactivate the user accounts of your deployment, one at a time or in bulk.

Groups

Manage permission groups, the named sets of users that resources can be shared with, and their members.

Backups

Create, list, download, restore, and delete full backups of the platform database and stored files.

Company

Read and update the organisation's company profile and billing details.

Platform settings and logs

Read and change the Chat service's runtime settings, and read its recent error and warning log entries.

OperationsHealth checks for monitoring and load balancers.

Health

Liveness probes that report whether the Chat service is running.