Update conversation attachment

Base URL: https://{kibana_url}

PUT /api/agent_builder/conversations/{conversation_id}/attachments/{attachment_id}

Auth

Update an attachment content. Creates a new version if content changed.

Required authorization

Privileges agentBuilder:read

Path parameters

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 update.

Header parameters

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

Request body

data object required: The new attachment data/content.
description string · max length: 2048: Optional new description for the attachment.
render_inline boolean · default: false: When true, the attachment is rendered inline in the UI when the conversation is opened, without the agent referencing it.

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Example request for updating attachment content

Console Kibana Dev Tools

PUT kbn:/api/agent_builder/conversations/CONVERSATION_ID/attachments/ATTACHMENT_ID
{
  "data": "This is the updated content"
}

Generated from the API spec

curl Shell

curl -X PUT "${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 '{
    "data": "This is the updated content"
  }'

Generated from the API spec

Response

Example response returning the updated attachment with new version

{
  "attachment": {
    "active": true,
    "current_version": 2,
    "description": "Meeting notes",
    "id": "att-abc123",
    "type": "text",
    "versions": [
      {
        "content_hash": "sha256-abc",
        "created_at": "2025-01-06T10:00:00.000Z",
        "data": "Original content",
        "estimated_tokens": 10,
        "version": 1
      },
      {
        "content_hash": "sha256-def",
        "created_at": "2025-01-06T11:00:00.000Z",
        "data": "This is the updated content",
        "estimated_tokens": 12,
        "version": 2
      }
    ]
  },
  "new_version": 2
}

Request Console 1 / 2 languages

Example request for updating both content and description

Console Kibana Dev Tools

PUT kbn:/api/agent_builder/conversations/CONVERSATION_ID/attachments/ATTACHMENT_ID
{
  "data": "New content version",
  "description": "Updated meeting notes - v2"
}

Generated from the API spec

curl Shell

curl -X PUT "${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 '{
    "data": "New content version",
    "description": "Updated meeting notes - v2"
  }'

Generated from the API spec

Response

Example response returning the updated attachment with new version

{
  "attachment": {
    "active": true,
    "current_version": 2,
    "description": "Meeting notes",
    "id": "att-abc123",
    "type": "text",
    "versions": [
      {
        "content_hash": "sha256-abc",
        "created_at": "2025-01-06T10:00:00.000Z",
        "data": "Original content",
        "estimated_tokens": 10,
        "version": 1
      },
      {
        "content_hash": "sha256-def",
        "created_at": "2025-01-06T11:00:00.000Z",
        "data": "This is the updated content",
        "estimated_tokens": 12,
        "version": 2
      }
    ]
  },
  "new_version": 2
}

Required authorization

Path parameters

Header parameters

Request body { }

Response

Request body