Skip to main content
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
aiAgents
/
{agentUuid}
/
threads
/
{threadUuid}
/
stream
Error
A valid request URL is required to generate request examples
{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lightdash.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

ā€‹
projectUuid
string
required
ā€‹
agentUuid
string
required
ā€‹
threadUuid
string
required

Body

application/json
ā€‹
toolHints
string[]

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.

ā€‹
enableSqlMode
boolean

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