# Lightdash Ee API

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

Lightdash Ee API is one of 63 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 EE. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

The Ee API from Lightdash — 11 operation(s) for ee.

## Operations (13)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/ee/projects/{projectUuid}/agent-onboarding` | Start agent onboarding run |
| GET | `/api/v1/ee/projects/{projectUuid}/agent-onboarding` | Get active agent onboarding run |
| GET | `/api/v1/ee/projects/{projectUuid}/agent-onboarding/{agentOnboardingRunUuid}` | Get agent onboarding run |
| GET | `/api/v1/ee/projects/{projectUuid}/agent-onboarding/{agentOnboardingRunUuid}/file` | Get onboarding run file |
| POST | `/api/v1/ee/projects/{projectUuid}/agent-onboarding/{agentOnboardingRunUuid}/cancel` | Cancel agent onboarding run |
| POST | `/api/v1/ee/projects/{projectUuid}/ai-deep-research` | Start Deep Research run |
| GET | `/api/v1/ee/projects/{projectUuid}/ai-deep-research` | List Deep Research runs |
| GET | `/api/v1/ee/projects/{projectUuid}/ai-deep-research/{aiDeepResearchRunUuid}` | Get Deep Research run |
| POST | `/api/v1/ee/projects/{projectUuid}/ai-deep-research/{aiDeepResearchRunUuid}/charts/{chartKey}/refresh` | Refresh Deep Research chart |
| GET | `/api/v1/ee/projects/{projectUuid}/ai-deep-research/{aiDeepResearchRunUuid}/queries/{queryUuid}/results` | Get deep research chart query results |
| GET | `/api/v1/ee/projects/{projectUuid}/ai-deep-research/{aiDeepResearchRunUuid}/charts/{queryUuid}` | Get Deep Research chart |
| GET | `/api/v1/ee/projects/{projectUuid}/ai-deep-research/{aiDeepResearchRunUuid}/events` | List Deep Research events |
| POST | `/api/v1/ee/projects/{projectUuid}/ai-deep-research/{aiDeepResearchRunUuid}/cancel` | Cancel Deep Research run |

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-ee-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 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/)
- [Lightdash Files API](https://apis.io/apis/lightdash/lightdash-files-api/)

## Tags

EE

---

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