/
LI
lightdash
/
Lightdash API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1mo ago · Updated 1mo ago
Details
Filter operations
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
Notifications
2
Organization Warehouse Credentials
5
Organizations
68
delete
Clear default organization design
post
Confirm domain verification
get
List color palettes
post
Create color palette
get
List organization groups
post
Create group
post
Create invite link
delete
Revoke all invite links
get
Get current organization
put
Create organization
patch
Update current organization
get
List organization designs
post
Create organization design
get
List organization projects
post
Create project
post
Upload file to organization design
delete
Delete all files from organization design
get
Get Azure AD SSO configuration
put
Upsert Azure AD SSO configuration
delete
Delete Azure AD SSO configuration
delete
Delete color palette
patch
Update color palette
get
Get email whitelabel configuration
put
Set up email sending domain
delete
Delete email sending domain
patch
Enable or disable email sending domain
get
Download file from organization design
delete
Delete file from organization design
get
Get generic OIDC SSO configuration
put
Upsert generic OIDC SSO configuration
delete
Delete generic OIDC SSO configuration
get
Get Google SSO configuration
put
Upsert Google SSO configuration
delete
Delete Google SSO configuration
get
Get Okta SSO configuration
put
Upsert Okta SSO configuration
delete
Delete Okta SSO configuration
get
Get OneLogin SSO configuration
put
Upsert OneLogin SSO configuration
delete
Delete OneLogin SSO configuration
delete
Delete organization
get
Get organization design
delete
Delete organization design
patch
Update organization design
delete
Delete organization member
delete
Delete verified domain
post
Ensure playground project
post
Fetch organization brand
get
Get impersonation settings
patch
Update impersonation settings
get
Get invite link
get
Get organization brand
put
Save organization brand
get
Get organization member by email
get
Get organization member by UUID
get
Get organization settings
patch
Update organization settings
get
Get user schedulers
get
List allowed email domains
patch
Update allowed email domains
get
List organization members
get
List verified domains
post
/api/v1/invite-links/{inviteCode}/activate
patch
Reassign schedulers
post
Request domain verification
post
Set active color palette
post
Set default organization design
post
Verify email sending domain
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
Organizations
post
/api/v1/invite-links/{inviteCode}/activate
Path parameters
inviteCode
string
required
Response
Success
ApiRegisterUserResponse
required
results
LightdashUser
required
status
'ok'
required
Changes