Delete an agent Technical Preview

View as Markdown
DELETE /api/agent_builder/agents/{id}
Api key auth

Spaces method and path for this operation:

delete /s/{space_id}/api/agent_builder/agents/{id}

Refer to Spaces for more information.

Delete an agent by ID. This action cannot be undone.

[Required authorization] Route required privileges: manage_onechat.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • id string Required

    The unique identifier of the agent to delete.

Responses

  • 200 application/json

    Indicates a successful response

DELETE /api/agent_builder/agents/{id} 
curl \
 --request DELETE 'https://<KIBANA_URL>/api/agent_builder/agents/{id}' \
 --header "Authorization: $API_KEY" \
 --header "kbn-xsrf: true"
Response examples (200)
Example response showing that deletion of the agent has been successful 
{
  "success": true
}