Skip to content

API reference ​

Every endpoint of the Lex API, generated from the platform's OpenAPI document. Base URL:

https://api.lexcetha.com/api/v1

Download the full spec as openapi.json to generate a client or import it into Postman or Insomnia.

GroupWhat it covers
AuthSign in, register, sign out and the current user.WorkspacesThe active workspace, switching workspaces and members.BotsCreate, configure, archive and restore bots.Chat & runsSend messages, stream replies, chat threads and approvals.AttachmentsUpload files to send with a message.ConnectorsConnect accounts, manage connections and policies, run tools.CatalogBrowse skills, plugins, connectors and Mini Programs.SkillsAuthor skills and assign them to bots.PluginsInstall and configure plugins for a workspace.SchedulesRun bots on a schedule and inspect scheduled runs.DocumentsDocuments, folders, versions and export.Virtual desktopsDesktop sessions bots use to work.Mini Programs (runtime)Open published Mini Programs and broker their capabilities.ContributorBuild, validate and submit Mini Programs.UsageToken and tool usage for the workspace.HealthLiveness and readiness probes.

Read the API integration guide first: it explains sign-in, the client header, errors and streaming, which the reference assumes.

Lex by Gavalytics AI