Create conversation attachment

Base URL: https://{kibana_url}

POST /api/agent_builder/conversations/{conversation_id}/attachments

Auth

Create a new attachment for a conversation with version tracking.

Required authorization

Privileges agentBuilder:read

Path parameters

conversation_id string · max length: 256 required: The unique identifier of the conversation.

Header parameters

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

Request body

data object required: The attachment data/content. Required unless origin is provided.
description string · max length: 2048: Human-readable description of the attachment.
hidden boolean: Whether the attachment should be hidden from the user.
id string · max length: 256: Optional custom ID for the attachment.
origin string · max length: 2048: Origin string (for example, saved object ID) for by-reference attachments. When provided without data, the content is resolved once at creation time.
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.
type string · max length: 256 required: The type of the attachment (e.g., text, esql, visualization).

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Example request for creating a hidden attachment

Console Kibana Dev Tools

POST kbn:/api/agent_builder/conversations/CONVERSATION_ID/attachments
{
  "data": "Internal system data",
  "description": "System context",
  "hidden": true,
  "type": "text"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/agent_builder/conversations/${CONVERSATION_ID}/attachments" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": "Internal system data",
    "description": "System context",
    "hidden": true,
    "type": "text"
  }'

Generated from the API spec

Response

Example response returning the created attachment

{
  "attachment": {
    "active": true,
    "current_version": 1,
    "description": "Meeting notes",
    "id": "att-abc123",
    "type": "text",
    "versions": [
      {
        "content_hash": "sha256-xyz",
        "created_at": "2025-01-06T10:00:00.000Z",
        "data": "This is the content of my text attachment",
        "estimated_tokens": 12,
        "version": 1
      }
    ]
  }
}

Request Console 1 / 2 languages

Example request for creating a JSON attachment with custom ID

Console Kibana Dev Tools

POST kbn:/api/agent_builder/conversations/CONVERSATION_ID/attachments
{
  "data": {
    "configuration": {
      "enabled": true,
      "threshold": 50
    },
    "metadata": {
      "source": "user_input"
    }
  },
  "description": "Application settings",
  "id": "custom-attachment-id",
  "type": "json"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/agent_builder/conversations/${CONVERSATION_ID}/attachments" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "configuration": {
        "enabled": true,
        "threshold": 50
      },
      "metadata": {
        "source": "user_input"
      }
    },
    "description": "Application settings",
    "id": "custom-attachment-id",
    "type": "json"
  }'

Generated from the API spec

Response

Example response returning the created attachment

{
  "attachment": {
    "active": true,
    "current_version": 1,
    "description": "Meeting notes",
    "id": "att-abc123",
    "type": "text",
    "versions": [
      {
        "content_hash": "sha256-xyz",
        "created_at": "2025-01-06T10:00:00.000Z",
        "data": "This is the content of my text attachment",
        "estimated_tokens": 12,
        "version": 1
      }
    ]
  }
}

Request Console 1 / 2 languages

Example request for creating a text attachment

Console Kibana Dev Tools

POST kbn:/api/agent_builder/conversations/CONVERSATION_ID/attachments
{
  "data": "This is the content of my text attachment",
  "description": "Meeting notes",
  "type": "text"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/agent_builder/conversations/${CONVERSATION_ID}/attachments" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": "This is the content of my text attachment",
    "description": "Meeting notes",
    "type": "text"
  }'

Generated from the API spec

Response

Example response returning the created attachment

{
  "attachment": {
    "active": true,
    "current_version": 1,
    "description": "Meeting notes",
    "id": "att-abc123",
    "type": "text",
    "versions": [
      {
        "content_hash": "sha256-xyz",
        "created_at": "2025-01-06T10:00:00.000Z",
        "data": "This is the content of my text attachment",
        "estimated_tokens": 12,
        "version": 1
      }
    ]
  }
}

Required authorization

Path parameters

Header parameters

Request body { }

Response

Request body