Skip to content

Log Interaction

POST/v1/core/interactions/log

Logs a behavioral interaction that an agent took on an entity. This builds the behavioral graph used for future ML recommendations.

Request

json
{
  "entity_id": "ent_550e8400-e29b-41d4-a716-446655440000",
  "agent_id": "outreach-agent-v1",
  "api": "sendgrid",
  "action_type": "send_email",
  "action": "sent follow-up reminder email",
  "outcome": "success",
  "metadata": {
    "template_id": "tpl_123"
  }
}

Parameters

NameTypeRequiredDescription
entity_idstringYesTarget entity UUID
agent_idstringYesName/ID of the agent acting
apistringYesExternal service used (stripe, github, etc)
action_typestringYesHigh level action category (send_email)
actionstringYesDescription of what happened
outcomestringYessuccess, failed, pending, ignored, unknown
intentstringNoGoal of the action (e.g. payment_recovery)
metadataobjectNoCustom JSON data

Response

Returns the ID of the created interaction log.

json
{
  "interaction_id": "int_3A21F...",
  "entity_id": "ent_550e...",
  "logged_at": "2026-03-04T12:00:00Z"
}

Batch Log Interactions

POST/v1/core/interactions/batch

You can log up to 100 interactions in a single request for high-volume agents.

Request

json
{
  "interactions": [
    {
      "entity_id": "...",
      "api": "...",
      "action_type": "...",
      "action": "...",
      "outcome": "...",
      "agent_id": "..."
    }
  ]
}

Released under the MIT License.