Lightdash

Lightdash Documents API

The Documents API from Lightdash — 13 operation(s) for documents.

GitHub OpenAPI

Operations 17

POST /api/v1/projects/{projectUuid}/documents/{documentUuid}/charts/{chartId}/query Execute document chart query #
PATCH /api/v1/projects/{projectUuid}/documents/{documentUuidOrSlug}/pinning Toggle document pin #
POST /api/v1/projects/{projectUuid}/documents/{documentUuid}/verification Verify Document #
DELETE /api/v1/projects/{projectUuid}/documents/{documentUuid}/verification Unverify Document #
POST /api/v1/projects/{projectUuid}/documents Create document #
GET /api/v1/projects/{projectUuid}/documents List documents #
POST /api/v1/projects/{projectUuid}/documents/{documentUuidOrSlug}/duplicate Duplicate document #
POST /api/v1/projects/{projectUuid}/documents/{documentUuidOrSlug}/exports/pdf Export document as PDF #
GET /api/v1/projects/{projectUuid}/documents/{documentUuid}/promoteDiff Get Document promotion diff #
POST /api/v1/projects/{projectUuid}/documents/{documentUuid}/promote Promote Document #
PATCH /api/v1/projects/{projectUuid}/documents/{documentUuidOrSlug} Update document metadata #
GET /api/v1/projects/{projectUuid}/documents/{documentUuidOrSlug} Get document #
POST /api/v1/projects/{projectUuid}/documents/{documentUuid}/versions Update document content #
GET /api/v1/projects/{projectUuid}/documents/{documentUuid}/versions List document versions #
GET /api/v1/projects/{projectUuid}/documents/{documentUuid}/versions/{versionUuid} Get document version #
GET /api/v1/projects/{projectUuid}/documents/{documentUuidOrSlug}/as-code Get document as code #
GET /api/v1/projects/{projectUuid}/documents/linking-chart Documents linking a chart #

Documentation

📖
Documentation
https://docs.lightdash.com/api-reference/v1/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-documents-api-openapi.yml

Schemas & Data

📊
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

Other Resources

🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightdash:lightdash-documents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightdash-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightdash Documents API
  version: 2.616.2
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens'
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:


# --- truncated at 32 KB (202 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-documents-api-openapi.yml