Message the "Native Data Quality Advisor" Agent (streaming)

Post a new Message to the Chat using the "Native Data Quality Advisor" 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. Optionally, a 'tool_approvals' parameter may be accepted with a dictionary of tool_call_id to approval boolean. When submitting tool approvals, the input payload must match the original inputs used to generate the tool calls (same as the previous API call). If tool_approvals is provided, the message parameter is ignored and the tool calls are executed or skipped.

object | null

[LEGACY] A mapping of tool_call_id to approval boolean. When submitting tool approvals, the input payload must match the original inputs used to generate the tool calls (same as the previous API call). If tool_approvals is provided, the message parameter is ignored and the tool calls are executed or skipped. Prefer using 'approvals' field for new integrations.

object | null

A mapping of function name to approval decision for codemode agents. Applies to functions decorated with @requires_approval. Use 'approve' for one-time approval, 'approve_session' for session-level approval, 'deny' for one-time denial, or 'deny_session' to deny for the session.

string
required
length ≥ 1

The message to send to the agent.

Optional table ID for initial context (e.g., 'table.25').

array | null

Optional list of skill IDs to use. When provided, only these skills are
fetched and applied. Useful for testing a specific skill in isolation.

Optional existing skill content for improvement. When provided, the agent
analyzes this content and suggests improvements based on the rules catalog.

object | null

Optional table metadata from the DQ monitor setup flow.

Each column includes a column_id (integer) which must be used as the key
in the output checks dict. Example structure:
{
"table_id": 24,
"table_name": "data_products",
"schema_name": "public",
"ds_title": "Alation Analytics",
"columns": [
{
"column_id": 1629,
"column_name": "contact_email",
"column_type": "text"
},
{
"column_id": 1501,
"column_name": "delivery_system_count",
"column_type": "int8(64,0)"
}
]
}

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

204

The message is empty and was ignored.

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
text/event-stream