Home
HomeGuidesRecipesAPI ReferencePython SDKAI Agent SDKAlation Data Quality SDKAlation's MCP Server
HomeAlation Help Center
API Reference
Alation Help Center

Message the "Query" Agent (streaming)

post
{protocol}://{base-url}/ai/api/v1/chats/agent/default/sql_query_agent/stream

Post a new Message to the Chat using the "Query" Agent.

Query Params

The ID of the Chat to use. If not provided, a new Chat will be created.

array | null

If creating a new chat, add these tags to it. This is ignored if the chat already exists.

Body Params

The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions.

string
required
length ≥ 1

The message to send to the agent.

string
required
length ≥ 1

The ID of the data product to use.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

204

The message is empty and was ignored.

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
text/event-stream

Updated 5 months ago

Did this page help you?