Create conversation
https://{kibana_url}
- POST /api/agent_builder/conversations
- POST /s/{space_id}/api/agent_builder/conversations
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.
[Required authorization] Route required privileges: agentBuilder:read.
Request
-
access_controlobject -
Optional access control settings. Defaults to private.
-
access_moderequired -
Access-control mode:
private(only the owner and the listed members can read and continue the conversation),public(any user with access to the conversation's agent can read and continue it). -
Values:
privatepublic -
entriesobject · max: 100 -
Members to share the conversation with. The list replaces the stored one; submit an empty list to unshare. Entries naming the owner are ignored. Must be empty when
access_modeispublic; repeated ids are rejected. -
idstring · min: 1 · max: 1024required -
Stable identifier of the user to share the conversation with: a Kibana user profile uid. Users without a profile cannot be granted access.
-
rolerequired -
Role granted to the principal.
memberis the only role: it grants read and converse access to the conversation. -
Values:
member -
typerequired -
Values:
user -
agent_idstring · max: 64 -
The ID of the agent to associate with the conversation. Defaults to the default Elastic AI agent.
-
conversation_idstring · max: 256 -
Optional client-supplied UUID for the conversation. Server-generated if omitted.
-
metadatamap string to string | number | boolean | string[] -
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 · min: 1 · max: 256 -
Optional ID of a conversation template to apply. When set, the template seeds default metadata and any caller-supplied
metadatais validated against the template field definitions. -
titlestring · max: 500 -
Title for the conversation. Defaults to "New conversation".
Response
Indicates a successful response