Sign in
agent builder

Update an agent

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Update an existing agent configuration. Use this endpoint to modify any aspect of the agent's behavior, appearance, or capabilities. To learn more about agents, refer to the agents documentation.<br/><br/>[Required authorization] Route required privileges: agentBuilder:manageAgents.

put/api/agent_builder/agents/{id}

Path parameters

idstring required

The unique identifier of the agent to update.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

avatar_colorstring

Updated hex color code for the agent avatar.

avatar_symbolstring

Updated symbol/initials for the agent avatar.

descriptionstring

Updated description of what the agent does.

labelsstring[]

Updated labels for categorizing and organizing agents.

namestring

Updated display name for the agent.

Response

Indicates a successful response

Changes

Changed in 3 of the 176 revisions of this API.3

  • 61c4fbe0c6671See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

  • 80b8dc2b167a1See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

  • 85a9129500cd1See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

Of the 176 revisions, 20 have no diff computed.