How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightdash AI Agents API

The AI Agents API from Lightdash — 13 operation(s) for ai agents.

Lightdash AI Agents API is one of 49 APIs that Lightdash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include AI Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.

This API exposes 16 operations across 13 paths, and defines 85 schemas. It is described by OpenAPI 3.2.0, at version 0.3156.1.

Requests are made against a single base URL, /.

16 operations 13 paths 85 schemas 1 DELETE11 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.3156.1
Base URL
https://app.lightdash.cloud
Authentication
API Key, API Key
License
MIT
Resource Areas
1

Authentication & Security 2

Lightdash AI Agents API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as connect.sid (session_cookie). An API key is passed in the header as Authorization (api_key).

  • api_key — Value should be 'ApiKey '

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 1 DELETE, 11 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

AI Agents 16
GET
/api/v1/aiAgents/documents
List ai agent documents
listAiAgentDocuments 1 param → 200default
POST
/api/v1/aiAgents/documents
Create ai agent document
createAiAgentDocument body → 201default
DELETE
/api/v1/aiAgents/documents/{documentUuid}
Delete ai agent document
deleteAiAgentDocument 1 param → 200default
GET
/api/v1/aiAgents/admin/threads
List AI agent threads
getAllThreads 12 params → 200default
GET
/api/v1/aiAgents/admin/agents
List AI agents
getAllAgents → 200default
GET
/api/v1/aiAgents/admin/review-items
List AI agent review items
getAiAgentReviewItems 1 param → 200default
GET
/api/v1/aiAgents/admin/review-items/{fingerprint}
List AI agent review signals
getAiAgentReviewItem 1 param → 200default
PATCH
/api/v1/aiAgents/admin/review-items/{fingerprint}
Update AI agent review item status
updateAiAgentReviewItemStatus 1 param body → 200default
GET
/api/v1/aiAgents/admin/review-items/{fingerprint}/activity
Get AI agent review item activity
getAiAgentReviewItemActivity 1 param → 200default
GET
/api/v1/aiAgents/admin/review-items/{fingerprint}/pr-diff
Get AI agent review item PR diff
getAiAgentReviewItemPrDiff 1 param → 200default
GET
/api/v1/aiAgents/admin/review-items/by-preview-thread/{threadUuid}
Get AI agent review item by preview thread
getAiAgentReviewItemByPreviewThread 1 param → 200default
POST
/api/v1/aiAgents/admin/review-items/{fingerprint}/writeback
Create AI agent review item writeback PR
createAiAgentReviewItemWriteback 1 param → 200default
GET
/api/v1/aiAgents/admin/review-items/{fingerprint}/writeback-preview
Preview AI agent review item writeback diff
getAiAgentReviewItemWritebackPreview 1 param → 200default
GET
/api/v1/aiAgents/admin/review-signals
Get ai agent review signals
getAiAgentReviewSignals → 200default
GET
/api/v1/aiAgents/admin/settings
Get AI settings
getAiOrganizationSettings → 200default
PATCH
/api/v1/aiAgents/admin/settings
Update AI settings
upsertAiOrganizationSettings body → 200default

Schemas 85

The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are AiAgentReviewItem (24 properties), AiAgentReviewRemediation (21 properties), Pick_AiAgent.uuid-or-name-or-description-or-integrations-or-tags-or-projectUuid-or-organizationUuid-or-createdAt-or-updatedAt-or-instruction-or-imageUrl-or-groupAccess-or-userAccess-or-spaceAccess-or-enableDataAccess-or-enableSelfImprovement-or-enableContentTools-or-version_ (18 properties), AiAgentReviewSignalSummary (17 properties). Each schema is shown below with its type and property counts.

AiAgentJudgeProjectContextEntry
object
6 properties 6 required
AiAgentSummary
AiAgentConfigurationSetting
string
ApiCreateAiAgentDocument
object
6 properties 4 required
AiAgentTurnSignal
string
KnexPaginateArgs
object
2 properties 2 required
ApiAiAgentDocumentSummaryListResponse
object
2 properties 2 required
AiAgentReviewItem
object
24 properties 24 required
AiAgentAdminFeedbackSummary
object
4 properties 4 required
AiAgentReviewClassifierEventType
string
ApiSuccessEmpty
object
2 properties 1 required
AiAgentAdminSortField
string
AiAgentReviewRemediationStatus
string
ApiAiAgentReviewItemResponse
AiAgentReviewItemWritebackStatus
string
AiAgentReviewItemStatus
string
AiAgentReviewRemediationEventDetail
AiAgentReviewItemOwnerType
string
AiAgentRecommendation
object
4 properties 4 required
AiAgentReviewClassifierConfidence
string
ApiSuccess_AiAgentReviewItemPrDiff_
object
2 properties 2 required
AiAgentReviewItemSummary
AiAgentReviewItemPrState
string
UpdateAiAgentReviewItemStatus
object
2 properties 2 required
ApiSuccess_AiOrganizationSettings_
object
2 properties 2 required
ApiAiAgentDocumentResponse
object
2 properties 2 required
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties 2 required
AiAgentReviewClassifierRunScope
ApiSuccess_AiAgentReviewItemWritebackPreview_
object
2 properties 2 required
AnyType
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 onl…
AiAgentDocument
object
14 properties 14 required
AiAgentDocumentStructuredSummary
object
6 properties 6 required
ApiUpdateAiOrganizationSettingsResponse
AiAgentDocumentSummary
AiAgentRecommendationAction
string
ApiAiAgentSummaryResponse
object
2 properties 2 required
Record_string.unknown_
object
Construct a type with a set of properties K of type T
AiAgentReviewItemPrDiffFile
object
6 properties 6 required
AiAgentReviewRemediationLiveState
string
The in-flight step of a remediation, derived from current status + which events exist — never stored. Renders as the single accented "live" row.
AiAgentReviewItemWritebackEligibility
ApiAiAgentAdminConversationsResponse
AiAgentReviewRemediationEvent
UpdateAiOrganizationSettings
ThreadSummary
AiAgentReviewItemPrDiff
object
5 properties 5 required
ComputedAiOrganizationSettings
object
2 properties 2 required
ApiAiAgentReviewItemPrDiffResponse
AiAgentDocumentRelevance
string
AiAgentEvidenceExcerpt
object
3 properties 3 required
AiAgentSemanticTargetRef
AiAgentTargetRef
Partial_Omit_AiOrganizationSettings.organizationUuid__
object
Make all properties in T optional
2 properties
AiOrganizationSettings
object
3 properties 3 required
Pick_AiAgentSummary.uuid-or-name-or-imageUrl_
object
From T, pick a set of properties whose keys are in the union K
3 properties 3 required
AiAgentReviewItemWritebackBlockedReason
string
ApiSuccess_AiAgentReviewItemActivity_
object
2 properties 2 required
Omit_AiAgentDocument.storageKey_
Construct a type with the properties of T except for those in type K.
AiAgentAdminConversationsSummary
object
1 property 1 required
AiAgentReviewItemWritebackStrategy
string
ApiAiOrganizationSettingsResponse
PullRequestProvider
string
AiAgentAdminThreadSummary
AiAgentUser
object
2 properties 2 required
AiAgentReviewItemActivity
object
3 properties 3 required
Pick_AiAgentDocument.Exclude_keyofAiAgentDocument.storageKey__
object
From T, pick a set of properties whose keys are in the union K
13 properties 13 required
ApiAiAgentReviewItemActivityResponse
ApiSuccess_KnexPaginatedData_AiAgentAdminConversationsSummary__
object
2 properties 2 required
ApiSuccess_AiAgentReviewSignalSummary-Array_
object
2 properties 2 required
AiAgentReviewSignalSummary
object
17 properties 17 required
AiAgentReviewItemWritebackPreview
Preview of the file change a writeback PR would make, computed deterministically (no PR opened). Only available for the projectcontext strategy — semanticlayer…
ApiAiAgentReviewItemWritebackPreviewResponse
ApiSuccess_AiAgentReviewItemSummary-Array_
object
2 properties 2 required
ApiSuccess_AiOrganizationSettings-and-ComputedAiOrganizationSettings_
object
2 properties 2 required
AiAgentRootCause
string
ApiSuccess_AiAgentReviewItemSummary_
object
2 properties 2 required
AiAgentReviewItemDismissedReason
string
Record_string.never_
object
Construct a type with a set of properties K of type T
ApiAiAgentReviewItemsResponse
Pick_AiAgent.uuid-or-name-or-description-or-integrations-or-tags-or-projectUuid-or-organizationUuid-or-createdAt-or-updatedAt-or-instruction-or-imageUrl-or-groupAccess-or-userAccess-or-spaceAccess-or-enableDataAccess-or-enableSelfImprovement-or-enableContentTools-or-version_
object
From T, pick a set of properties whose keys are in the union K
18 properties 18 required
AiAgentReviewRemediation
object
21 properties 21 required
Pick_AiAgentThreadSummary_AiAgentUser-and-_slackUserId-string-or-null--email-string-or-null__.user-or-createdAt-or-createdFrom-or-title-or-uuid_
object
From T, pick a set of properties whose keys are in the union K
5 properties 5 required
AiAgentFixTarget
string
AiAgentImplicitSignalSource
string
KnexPaginatedData_AiAgentAdminConversationsSummary_
object
2 properties 1 required
ApiAiAgentReviewSignalsResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightdash-ai-agents-api-openapi.yml Raw ↑

Other APIs Lightdash publishes across the network.

Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets API
Lightdash Charts API
Lightdash Comments API
Lightdash Content API
Lightdash Custom Roles API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exploring API
Lightdash Exports API
Lightdash Feature Flag API
Where this information came from

This is an independent, third-party profile of Lightdash AI Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.