Workflow Agent

Save brand message with embedding

Saves a brand message to the database with generated embedding for semantic search. This endpoint is used by workflow agents to store messages with full context.

post/api/v1/workflow/agent/save-brand-message

Request

  • Base URL: https://api.kolect.com
  • URL: https://api.kolect.com/api/v1/workflow/agent/save-brand-message
  • Auth: HTTP bearer

Request body

brand_idstring required

The brand ID this message belongs to

channelstring required

The communication channel (e.g., 'feishu', 'slack', 'email')

senderstring required

The sender type (e.g., 'user', 'agent', 'staff')

contentstring required

The message content

metadataobject

Optional metadata object

ticket_idstring required

The ticket ID this message belongs to

partnership_idstring

Partnership ID (optional)

partnership_statusstring

Partnership status (optional)

bot_mentionedboolean

Whether the bot was mentioned (@) in the message (optional)

Example request

{
  "brand_id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "feishu",
  "sender": "user",
  "content": "Hello, I'm interested in your product",
  "metadata": {
    "message_id": "om_x100b49f3c1a61db00f472ef72e8a9de",
    "chat_id": "oc_7fad02e6ecf890b41216204948aaeb53",
    "direction": "inbound"
  },
  "ticket_id": "123e4567-e89b-12d3-a456-426614174000",
  "partnership_id": "456e7890-e89b-12d3-a456-426614174000",
  "partnership_status": "active",
  "bot_mentioned": true
}

Response

Message saved successfully

successboolean
messagestring

Example response

{
  "success": true,
  "data": {
    "id": "789e0123-e89b-12d3-a456-426614174000",
    "brand_id": "123e4567-e89b-12d3-a456-426614174000",
    "channel": "feishu",
    "sender": "user",
    "content": "Hello, I'm interested in your product",
    "metadata": {
      "message_id": "om_x100b49f3c1a61db00f472ef72e8a9de",
      "chat_id": "oc_7fad02e6ecf890b41216204948aaeb53",
      "direction": "inbound"
    },
    "created_at": "2024-01-01T12:00:00Z",
    "updated_at": "2024-01-01T12:00:00Z"
  },
  "message": "Brand message saved successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.