Rename attachment Technical Preview; added in 9.2.0

PATCH /api/agent_builder/conversations/{conversation_id}/attachments/{attachment_id}
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Rename an attachment without creating a new version.

[Required authorization] Route required privileges: read_agent_builder.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • conversation_id string Required

    The unique identifier of the conversation.

  • attachment_id string Required

    The unique identifier of the attachment to rename.

application/json

Body

  • description string Required

    The new description/name for the attachment.

Responses

  • 200 application/json

    Indicates a successful response

PATCH /api/agent_builder/conversations/{conversation_id}/attachments/{attachment_id} 
curl \
 --request PATCH 'https://localhost:5601/api/agent_builder/conversations/{conversation_id}/attachments/{attachment_id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"description":"Updated attachment name"}'
Request example
Example request for renaming an attachment 
{
  "description": "Updated attachment name"
}
Response examples (200)
Example response returning the renamed attachment (version unchanged) 
{
  "success": true,
  "attachment": {
    "id": "att-abc123",
    "type": "text",
    "active": true,
    "versions": [
      {
        "data": "Content remains the same",
        "version": 1,
        "created_at": "2025-01-06T10:00:00.000Z",
        "content_hash": "sha256-xyz",
        "estimated_tokens": 10
      }
    ],
    "description": "Updated attachment name",
    "current_version": 1
  }
}