POST /api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/stream

Request

Base URL
/ (relative, and the document’s source URL is not known)
Auth
none required
TypeScript
https://skmtc.dev/lightdash/apis/lightdash-api/docs/api/v1/projects/:projectUuid/aiAgents/:agentUuid/threads/:threadUuid/stream/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectUuidstring required

agentUuidstring required

threadUuidstring required

Request body

toolHintsstring[]

Tool names hinted by the user when they composed the message (via suggestion chips that carry a tool id). agentV2 appends a soft hint to the user message before sending it to the LLM. Transient — never persisted.

autoApproveSqlboolean

Skips the SQL human-approval gate for this stream. Used by the review remediation workspace so Continue PR turns run frictionlessly. Defaults to false — normal chat still asks the user to approve SQL.

enableSqlModeboolean

Per-thread toggle that decides whether the agent gets access to the runSql / listWarehouseTables / describeWarehouseTable tools for this stream. Frontend tracks the toggle in its slice; passed in on every stream call. Falls back to false when omitted (e.g. older clients, API callers) so the safer "semantic layer only" mode is the default.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.