From 236793badd1d1cfb49a00ab8022b88718788f824 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 19 May 2026 16:55:18 +0000 Subject: [PATCH 1/2] docs: document AI agents REST API access --- guides/ai-agents/getting-started.mdx | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/guides/ai-agents/getting-started.mdx b/guides/ai-agents/getting-started.mdx index bbdc8432..662e28c2 100644 --- a/guides/ai-agents/getting-started.mdx +++ b/guides/ai-agents/getting-started.mdx @@ -235,3 +235,31 @@ Once a channel is designated as the multi-agent channel, all eligible agents in If you see the error **"This Slack channel is already assigned to another AI agent"** while trying to attach a second agent via the per-agent integration path, that path only supports single-agent channels. Switch to the org-level multi-agent channel setup described above instead. +## Manage AI agents via the API + +You can create, update, and interact with AI agents programmatically using the Lightdash REST API. This is useful when you want to provision agents from scripts, automate evaluations in CI, or build custom integrations on top of agent threads. + +The AI agent endpoints are documented in the [API reference](/api-reference/v1/introduction) under the `ai-agents` tag. They are all scoped to a project and live under: + +``` +/api/v1/projects/{projectUuid}/aiAgents +``` + +Common operations include: + +- Listing, creating, updating, and deleting agents +- Configuring agent models, MCP servers, and verified content +- Starting threads, sending messages, and streaming responses +- Submitting feedback and managing artifacts produced by an agent + +Authenticate requests with a [personal access token](/references/workspace/personal-tokens): + +```bash +curl -H "Authorization: ApiKey $LIGHTDASH_API_KEY" \ + https:///api/v1/projects//aiAgents +``` + + +AI agent endpoints require AI features to be enabled for your organization and that the calling user has access to the target project. + + From 14178aae51ea234f841da35082eb04254b98cfac Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 19 May 2026 17:32:12 +0000 Subject: [PATCH 2/2] docs: remove stale ai-agents tag reference --- guides/ai-agents/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/ai-agents/getting-started.mdx b/guides/ai-agents/getting-started.mdx index 662e28c2..93d57969 100644 --- a/guides/ai-agents/getting-started.mdx +++ b/guides/ai-agents/getting-started.mdx @@ -239,7 +239,7 @@ If you see the error **"This Slack channel is already assigned to another AI age You can create, update, and interact with AI agents programmatically using the Lightdash REST API. This is useful when you want to provision agents from scripts, automate evaluations in CI, or build custom integrations on top of agent threads. -The AI agent endpoints are documented in the [API reference](/api-reference/v1/introduction) under the `ai-agents` tag. They are all scoped to a project and live under: +The AI agent endpoints are documented in the [API reference](/api-reference/v1/introduction). They are all scoped to a project and live under: ``` /api/v1/projects/{projectUuid}/aiAgents