Message an Agent (streaming)

post

https://{protocol}://{base-url}/ai/api/v1/chats/agent/{agent_config_id}/stream

Send messages to a specific custom agent.

Path Params

agent_config_id

string

required

The ID of the Agent Config to use.

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. 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.

tool_approvals

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.

approvals

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.

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.

402Tenant has no remaining tool calls. The request cannot be completed.

404Resource not found. The detail field specifies which resource.

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

413The payload exceeds the model's context window.

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

500Internal server error during request processing.