Message the "Data Product Query" Agent (async)

post

{protocol}://{base-url}/ai/api/v1/chats/agent/default/data_product_query_agent/call

Post a new message to the chat using the "Data Product Query" agent. This runs the chat as a background task and returns a task ID.

Query Params

chat_id

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

tags

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.

message

string

required

length ≥ 1

The message to send to the agent.

data_product_id

string

required

length ≥ 1

The ID of the data product to use.

auth_id

The ID of the authentication credentials to use for the query.

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

Loading…

Response

Choose an example:

application/json

text/event-stream

201Message sent successfully. Returns an event stream of Message objects.

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

404The chat could not be found.

409Chat is busy. Returns an event stream of the running chat.

422The payload is not valid according to the input JSON schema of the agent.

500Internal server error during request processing.