# Lightdash AI Agents API

**Canonical:** https://apis.io/apis/lightdash/lightdash-ai-agents-api/  
**Provider:** Lightdash — https://apis.io/providers/lightdash/  
**Base URL:** https://app.lightdash.cloud  
**Documentation:** https://docs.lightdash.com/api-reference/v1/introduction

Lightdash AI Agents API is one of 50 APIs that [Lightdash](https://apis.io/providers/lightdash/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 8 JSON Schema definitions. Tagged areas include AI Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

The AI Agents API from Lightdash — 13 operation(s) for ai agents.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/aiAgents/documents` | List ai agent documents |
| POST | `/api/v1/aiAgents/documents` | Create ai agent document |
| DELETE | `/api/v1/aiAgents/documents/{documentUuid}` | Delete ai agent document |
| GET | `/api/v1/aiAgents/admin/threads` | List AI agent threads |
| GET | `/api/v1/aiAgents/admin/agents` | List AI agents |
| GET | `/api/v1/aiAgents/admin/review-items` | List AI agent review items |
| GET | `/api/v1/aiAgents/admin/review-items/{fingerprint}` | List AI agent review signals |
| PATCH | `/api/v1/aiAgents/admin/review-items/{fingerprint}` | Update AI agent review item status |
| GET | `/api/v1/aiAgents/admin/review-items/{fingerprint}/activity` | Get AI agent review item activity |
| GET | `/api/v1/aiAgents/admin/review-items/{fingerprint}/pr-diff` | Get AI agent review item PR diff |
| GET | `/api/v1/aiAgents/admin/review-items/by-preview-thread/{threadUuid}` | Get AI agent review item by preview thread |
| POST | `/api/v1/aiAgents/admin/review-items/{fingerprint}/writeback` | Create AI agent review item writeback PR |
| GET | `/api/v1/aiAgents/admin/review-items/{fingerprint}/writeback-preview` | Preview AI agent review item writeback diff |
| GET | `/api/v1/aiAgents/admin/review-signals` | Get ai agent review signals |
| GET | `/api/v1/aiAgents/admin/settings` | Get AI settings |
| PATCH | `/api/v1/aiAgents/admin/settings` | Update AI settings |

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-ai-agents-api-openapi.yml
- **Documentation** — https://docs.lightdash.com/api-reference/v1/introduction
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-project.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-dashboard.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-chartsummary.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-space.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-scimuser.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-serviceaccount.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-schedulerandtargets.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-apierrorpayload.json
- **Vocabulary** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/vocabulary/lightdash-vocabulary.yml
- **JSONLDContext** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-ld/lightdash-context.jsonld

## Other Lightdash APIs (12)

- [Lightdash Bulk action API](https://apis.io/apis/lightdash/lightdash-bulk-action-api/)
- [Lightdash Catalog API](https://apis.io/apis/lightdash/lightdash-catalog-api/)
- [Lightdash Changesets API](https://apis.io/apis/lightdash/lightdash-changesets-api/)
- [Lightdash Charts API](https://apis.io/apis/lightdash/lightdash-charts-api/)
- [Lightdash Comments API](https://apis.io/apis/lightdash/lightdash-comments-api/)
- [Lightdash Content API](https://apis.io/apis/lightdash/lightdash-content-api/)
- [Lightdash Custom Roles API](https://apis.io/apis/lightdash/lightdash-custom-roles-api/)
- [Lightdash Dashboards API](https://apis.io/apis/lightdash/lightdash-dashboards-api/)
- [Lightdash Explorer API](https://apis.io/apis/lightdash/lightdash-explorer-api/)
- [Lightdash Exploring API](https://apis.io/apis/lightdash/lightdash-exploring-api/)
- [Lightdash Exports API](https://apis.io/apis/lightdash/lightdash-exports-api/)
- [Lightdash Feature Flag API](https://apis.io/apis/lightdash/lightdash-feature-flag-api/)

## Tags

AI Agents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/lightdash/lightdash-ai-agents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/lightdash/.