Rename attachment

Base URL: https://{kibana_url}

PATCH /api/agent_builder/conversations/{conversation_id}/attachments/{attachment_id}
PATCH /s/{space_id}/api/agent_builder/conversations/{conversation_id}/attachments/{attachment_id}

Auth

Rename an attachment without creating a new version.

Required privileges

Privileges agentBuilder:read

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
conversation_id string · max length: 256 required: The unique identifier of the conversation.
attachment_id string · max length: 256 required: The unique identifier of the attachment to rename.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

description string · max length: 2048 required: The new description/name for the attachment.

Response

200

Indicates a successful response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Example request for renaming an attachment

Console Kibana Dev Tools

PATCH kbn:/api/agent_builder/conversations/CONVERSATION_ID/attachments/ATTACHMENT_ID
{
  "description": "Updated attachment name"
}

Generated from the API spec

curl Shell

curl -X PATCH "${KIBANA_URL}/api/agent_builder/conversations/${CONVERSATION_ID}/attachments/${ATTACHMENT_ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated attachment name"
  }'

Generated from the API spec

Response

Example response returning the renamed attachment (version unchanged)

{
  "attachment": {
    "active": true,
    "current_version": 1,
    "description": "Updated attachment name",
    "id": "att-abc123",
    "type": "text",
    "versions": [
      {
        "content_hash": "sha256-xyz",
        "created_at": "2025-01-06T10:00:00.000Z",
        "data": "Content remains the same",
        "estimated_tokens": 10,
        "version": 1
      }
    ]
  },
  "success": true
}