/
LI
lightdash
/
Lightdash API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2w ago · Updated 2w ago
View markdown
lightdash
Lightdash API
get
Get authenticated user
v1
latest
OpenAPI 3.0.0
MIT
2026-07-26
400
1,540
832.7 KB
Catalog
27
Charts
14
Comments
4
Content
6
Dashboards
9
Exploring
3
Exports
1
Files
1
Funnel
2
Git Files
6
Git Integration
5
Homepage
18
Impersonation
2
Integrations
13
Map
1
Metrics Explorer
3
My Account
25
post
Complete Redshift AWS SSO login
put
Create email one-time passcode
get
List personal access tokens
post
Create personal access token
get
List warehouse credentials
post
Create warehouse credentials
put
Upload avatar
delete
Delete avatar
delete
Delete personal access token
delete
Delete user
delete
Delete warehouse credentials
patch
Update warehouse credentials
get
Get account
get
Get authenticated user
post
Register user
get
Get email verification status
get
Get login options
get
Get user avatar
post
Join organization
delete
Leave organization
get
List available organizations
post
/api/v1/user/login-email-otp
post
/api/v1/user/login-email-otp/verify
patch
Rotate personal access token
post
Start Redshift AWS SSO login
Notifications
2
Organization Warehouse Credentials
5
Organizations
68
Project
3
Projects
72
post
Add AI agent review item comment
post
Cancel agent onboarding run
post
Cancel Deep Research run
post
Capture AI review judge replay inputs
post
Commit router decision
get
List agent documents
post
Create agent document
get
List AI agent documents
post
Create AI agent document
get
List AI agent review items
post
Create AI agent review item
post
Create AI agent review item writeback PR
post
Create GitHub repository
delete
Delete agent document
delete
Delete AI agent document
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}
delete
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}
patch
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}
delete
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}
patch
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}
get
/api/v1/projects/{projectUuid}/aiAgents/preferences
post
/api/v1/projects/{projectUuid}/aiAgents/preferences
delete
/api/v1/projects/{projectUuid}/aiAgents/preferences
get
Get agent document content
get
Get agent onboarding run
get
Get AI agent review item activity
get
Get AI agent review item by preview thread
get
Get AI agent review item PR diff
get
Get AI agent thread pull request
get
Get AI review notification settings
get
Get AI router config
get
Get AI router instruction
get
Get AI settings
get
/api/v1/aiAgents/admin/review-signals
get
/api/v1/projects/{projectUuid}/aiAgents
post
/api/v1/projects/{projectUuid}/aiAgents
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/charts/{chartIndex}/viz-query
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/viz-query
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/runs
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/runs/{runUuid}
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/mcpServers
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/mcpServers/{mcpServerUuid}/tools
patch
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/mcpServers/{mcpServerUuid}/tools
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/models
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/suggestions
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/verified-artifacts
get
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/verified-questions
get
/api/v1/projects/{projectUuid}/aiAgents/mcpServers
post
/api/v1/projects/{projectUuid}/aiAgents/mcpServers
get
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/{mcpServerUuid}/tools
get
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/github/availability
get
/api/v1/projects/{projectUuid}/aiAgents/threads
get
/api/v1/projects/{projectUuid}/code/aiAgents
post
/api/v1/projects/{projectUuid}/code/aiAgents
get
Get Deep Research run
get
Get GitHub App configuration
get
Get linked GitHub account
get
Get MCP activity stats
get
Get onboarding run file
get
Get project AI agent prompt activity
get
GitHub OAuth callback
get
GitLab OAuth callback
get
Install GitHub App
get
Install GitLab integration
get
Link GitHub account
get
List AI agent review signals
get
List AI agent thread pull requests
get
List AI agent threads
get
List AI agents
get
List AI agents as code (deprecated)
get
List Deep Research events
get
List Deep Research runs
get
List GitHub repositories
get
List GitLab projects
get
List MCP activity
get
List router decisions
patch
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/savedDashboard
patch
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/verified
patch
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages/{messageUuid}/feedback
patch
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages/{messageUuid}/savedQuery
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/append-instruction
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/avatar
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluateReadiness
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/append
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/run
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/clone/{promptUuid}
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/generate
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/generate-title
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages/{messageUuid}/interrupt
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages/{messageUuid}/steers
post
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/shares
My Account
Get authenticated user
Get authenticated user
get
/api/v1/user
Response
Ok
ApiGetAuthenticatedUserResponse
required
Shows the authenticated user
results
object
required
status
'ok'
required