Sign in

v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
agent builder

Send chat message

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/agent_builder/converse</span></div>

Refer to Spaces for more information.

Send a message to an agent and receive a complete response. This synchronous endpoint waits for the agent to fully process your request before returning the final result. Use this for simple chat interactions where you need the complete response. To learn more about agent chat, refer to the agent chat documentation.<br/><br/>[Required authorization] Route required privileges: agentBuilder:read.

post/api/agent_builder/converse

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

_execution_mode'local' | 'task_manager'

define how to execute the agent (local execution or via task_manager)

action'regenerate'

The action to perform. "regenerate" re-executes the last round with the original input. Requires conversation_id.

agent_idstring

The ID of the agent to chat with. Defaults to the default Elastic AI agent.

connector_idstring nullable

Optional connector ID for the agent to use for model routing. Mutually exclusive with inference_id; omit or use only one.

conversation_idstring

Optional existing conversation ID to continue a previous conversation.

execution_idstring

Optional client-generated execution ID. Provide it to address this execution later (for example, to abort it). Must be unique; defaults to a server-generated ID.

inference_idstring nullable

Optional inference endpoint ID for model routing (public alias for the same internal identifier as connector_id). Mutually exclusive with connector_id.

inputstring

The user input message to send to the agent.

promptsobject

Use this field to respond to a confirmation, authorization, or ask_user_question prompt. Send an allow boolean to answer a confirmation prompt, an authorized boolean to answer an authorization prompt, or an answers array (one entry per question) to answer an ask_user_question prompt.

Response

Indicates a successful response