Lightdash Learn API

openapi: 3.2.0
info:
  title: Lightdash Learn 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:
- name: Learn
paths:
  /api/v1/projects/{projectUuid}/learn/workspace/files:
    get:
      operationId: ListLearnWorkspaceFiles
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiLearnWorkspaceFilesResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: List the files in the learner's sandbox workspace
      summary: List workspace files
      tags:
      - Learn
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
  /api/v1/projects/{projectUuid}/learn/workspace/files/{path}:
    get:
      operationId: GetLearnWorkspaceFile
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiLearnWorkspaceFileResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Get the content of a single file in the learner''s sandbox workspace.

        The path is URL-encoded (e.g. `models%2Forders.yml`); tsoa/Express

        decode it (including any encoded slashes) before it reaches this

        handler, so `path` already holds the plain file path.'
      summary: Get workspace file
      tags:
      - Learn
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
    put:
      operationId: SaveLearnWorkspaceFile
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Save the content of a single file in the learner''s sandbox workspace.

        The path is URL-encoded (e.g. `models%2Forders.yml`); tsoa/Express

        decode it (including any encoded slashes) before it reaches this

        handler, so `path` already holds the plain file path.'
      summary: Save workspace file
      tags:
      - Learn
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: path
        name: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                content:
                  type: string
              required:
              - content
              type: object
  /api/v1/projects/{projectUuid}/learn/workspace/commands:
    post:
      operationId: RunLearnWorkspaceCommand
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiLearnCommandCreatedResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Queue a lightdash or dbt command to run in the learner''s sandbox

        workspace'
      summary: Run workspace command
      tags:
      - Learn
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LearnSandboxCommandRequest'
  /api/v1/projects/{projectUuid}/learn/workspace/commands/{commandUuid}:
    get:
      operationId: GetLearnWorkspaceCommandOutput
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiLearnCommandOutputResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Get the status and output of a previously queued sandbox command.

        Pass `after` (the highest `seq` already received) to page through

        output as it streams in.'
      summary: Get workspace command output
      tags:
      - Learn
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      - in: path
        name: commandUuid
        required: true
        schema:
          type: string
      - in: query
        name: after
        required: false
        schema:
          format: double
          type: number
components:
  schemas:
    LearnWorkspaceFileSummary:
      properties:
        editable:
          type: boolean
        path:
          type: string
      required:
      - editable
      - path
      type: object
    LearnCommandOutput:
      properties:
        finishedAt:
          type:
          - string
          - 'null'
        startedAt:
          type:
          - string
          - 'null'
        chunks:
          items:
            $ref: '#/components/schemas/LearnCommandOutputChunk'
          type: array
        argv:
          items:
            type: string
          type: array
        exitCode:
          type:
          - number
          - 'null'
          format: double
        status:
          $ref: '#/components/schemas/LearnCommandStatus'
        commandUuid:
          type: string
      required:
      - finishedAt
      - startedAt
      - chunks
      - argv
      - exitCode
      - status
      - commandUuid
      type: object
    AnyType:
      description: 'This AnyType is an alias for any

        The goal is to make it easier to identify any type in the codebase

        without having to eslint-disable all the time

        These are only used on legacy `any` types, don''t use it for new types.

        This is added on a separate file to avoid circular dependencies.'
    ApiLearnCommandCreatedResponse:
      properties:
        results:
          properties:
            commandUuid:
              type: string
          required:
          - commandUuid
          type: object
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    LearnWorkspaceFile:
      properties:
        editable:
          type: boolean
        content:
          type: string
        path:
          type: string
      required:
      - editable
      - content
      - path
      type: object
    ApiLearnCommandOutputResponse:
      properties:
        results:
          $ref: '#/components/schemas/LearnCommandOutput'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    ApiLearnWorkspaceFilesResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/LearnWorkspaceFileSummary'
          type: array
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    LearnSandboxTool:
      type: string
      enum:
      - lightdash
      - dbt
    ApiSuccessEmpty:
      properties:
        results: {}
        status:
          type: string
          enum:
          - ok
      required:
      - status
      type: object
    LearnSandboxCommandRequest:
      properties:
        args:
          items:
            type: string
          type: array
        subcommand:
          type: string
        tool:
          $ref: '#/components/schemas/LearnSandboxTool'
      required:
      - args
      - subcommand
      - tool
      type: object
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
          - name
          - statusCode
          type: object
        status:
          type: string
          enum:
          - error
      required:
      - error
      - status
      type: object
      description: 'The Error object is returned from the api any time there is an error.

        The message contains'
    ApiLearnWorkspaceFileResponse:
      properties:
        results:
          $ref: '#/components/schemas/LearnWorkspaceFile'
        status:
          type: string
          enum:
          - ok
      required:
      - results
      - status
      type: object
    LearnCommandOutputChunk:
      properties:
        text:
          type: string
        stream:
          type: string
          enum:
          - stdout
          - stderr
        seq:
          type: number
          format: double
      required:
      - text
      - stream
      - seq
      type: object
    LearnCommandStatus:
      type: string
      enum:
      - queued
      - running
      - done
      - error
      - timeout
  securitySchemes:
    session_cookie:
      type: apiKey
      in: cookie
      name: connect.sid
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: Value should be 'ApiKey <your key>'
x-provenance:
  method: harvested
  publisher: Lightdash
  source: https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)