agent builder

Create conversation

Changed on

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/conversations</span></div>

Refer to Spaces for more information.

Create an empty conversation without sending a message. Returns the created conversation immediately. Use this to obtain a conversation ID before starting a chat session. To learn more about agent conversations, refer to the agent chat documentation.<br/><br/>[Required authorization] Route required privileges: agentBuilder:read.

post/api/agent_builder/conversations

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/agent_builder/conversations
  • Auth
    • API key in header Authorization
    • or HTTP basic

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

agent_idstring

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

conversation_idstring

Optional client-supplied UUID for the conversation. Server-generated if omitted.

metadataobject

Initial metadata values. Each key must be declared by the referenced template; each value is validated against the field definition (type, options, min/max, regex, max_length). Requires template_id.

template_idstring

Optional ID of a conversation template to apply. When set, the template seeds default metadata and any caller-supplied metadata is validated against the template field definitions.

titlestring

Title for the conversation. Defaults to "New conversation".

Response

Indicates a successful response

Changes