object

{}

object

{}

object

{}

object

{}

{
  label?:  string  // Human-readable key label.
  agentId?:  string  // Agent this key is scoped to.
  type?:  "public" | "secret"  // Key type. Public keys can create sessions. Secret keys have full API access.
  allowedOrigins?:  string[]  // Allowed CORS origins for this key.
}

{
  "label": "label",
  "agentId": "agentId",
  "type": "type",
  "allowedOrigins": []
}

{
  key:  string  // The full API key — shown only once.
  id:  string  // Key ID.
  label:  string
  type:  string
  agentId?:  string
}

{
  "key": "key",
  "id": "id",
  "label": "label",
  "type": "type",
  "agentId": "agentId"
}

{
  keys:  object[]
}

{
  "keys": []
}

{
  deleted:  boolean
}

{
  "deleted": false
}

{
  id:  string  // Unique agent ID (slug-style).
  name:  string  // Display name.
  personality?:  string  // System personality prompt.
  createdBy?:  string  // Creator identifier.
  avatarUrl?:  string  // Legacy image URL (prefer `avatar`).
  avatar?:  object  // Polymorphic avatar/incarnation metadata { kind, …data }.
  appearance?:  string  // Canonical appearance description (what the character looks like, constant across incarnations).
  models?:  object  // Per-role model overrides (master key only; not persisted across reboots - bench use).
}

{
  "id": "id",
  "name": "name",
  "personality": "personality",
  "createdBy": "createdBy",
  "avatarUrl": "avatarUrl",
  "avatar": null,
  "appearance": "appearance",
  "models": null
}

{
  agents:  object[]
  total:  number
}

{
  "agents": [],
  "total": 0
}

{
  agent:  object
}

{
  "agent": null
}

{
  name?:  string  // New display name.
  personality?:  string  // New personality prompt.
  avatarUrl?:  string  // Legacy image URL (prefer `avatar`).
  avatar?:  object  // Polymorphic avatar/incarnation metadata { kind, …data }.
  appearance?:  string  // Canonical appearance description (constant across incarnations).
  slug?:  string  // URL slug (lowercase + hyphens, must start with alphanumeric).
  description?:  string  // Hub-card tagline.
  visibility?:  "public" | "unlisted" | "private"  // Hub listing visibility.
  dmPolicy?:  "everyone" | "admins" | "off"  // Who may DM the agent: everyone / admins / off. Owner-only.
}

{
  "name": "name",
  "personality": "personality",
  "avatarUrl": "avatarUrl",
  "avatar": null,
  "appearance": "appearance",
  "slug": "slug",
  "description": "description",
  "visibility": "visibility",
  "dmPolicy": "dmPolicy"
}

{
  agent:  object
}

{
  "agent": null
}

{
  deleted:  boolean
}

{
  "deleted": false
}

{
  chatId:  string  // Scope chat id (e.g. the world slug for vibeworld scopes).
  platform?:  string  // Scope platform (floor + emission key).
  threadId?:  string
  text:  string  // The text to synthesize and play on the emission rail.
}

{
  "chatId": "chatId",
  "platform": "platform",
  "threadId": "threadId",
  "text": "text"
}

{
  images:  object[]
}

{
  "images": []
}

{
  profile:  object
  platforms:  object[]
  capabilities:  object[]
  uptime:  number  // Server uptime in seconds.
}

{
  "profile": null,
  "platforms": [],
  "capabilities": [],
  "uptime": 0
}

{
  threadCount:  number
  messageCount:  number
  lastActivityAt:  number
}

{
  "threadCount": 0,
  "messageCount": 0,
  "lastActivityAt": 0
}

{
  agentId:  string
  connections:  object[]
}

{
  "agentId": "agentId",
  "connections": []
}

{
  agentId:  string
  status:  string  // Connection status: connected / needs_auth / reconnecting / ...
  connected:  boolean
  qr:  string  // Raw QR payload to render when awaiting a scan. Null when connected/unavailable.
  pairingCode:  string  // Pairing code to enter in WhatsApp → Linked Devices, when BAILEYS_PAIRING_PHONE is set. Null otherwise.
}

{
  "agentId": "agentId",
  "status": "status",
  "connected": false,
  "qr": "qr",
  "pairingCode": "pairingCode"
}

{
  agentId:  string
  ok:  boolean
  message:  string
}

{
  "agentId": "agentId",
  "ok": false,
  "message": "message"
}

{
  value:  string  // The raw secret to store (e.g. a bot token). Stored encrypted; never echoed back.
}

{
  "value": "value"
}

{
  key:  string
  createdAt:  number
  updatedAt:  number
}

{
  "key": "key",
  "createdAt": 0,
  "updatedAt": 0
}

{
  key:  string
  deleted:  boolean  // True if a row was removed; false if none existed.
}

{
  "key": "key",
  "deleted": false
}

{
  agentId:  string
  credentials:  object[]
}

{
  "agentId": "agentId",
  "credentials": []
}

{
  token:  string  // The platform bot token (BotFather / Discord developer portal). Stored encrypted; validated before connecting.
}

{
  "token": "token"
}

{
  agentId:  string
  connections:  object[]
}

{
  "agentId": "agentId",
  "connections": []
}

{
  agentId:  string
  connections:  object[]
}

{
  "agentId": "agentId",
  "connections": []
}

{
  events:  object[]  // Reserved (empty) - private activity events are not exposed here.
  sessions:  object[]  // Durative sessions the agent is running now. Public callers see an ABSTRACT view (kind + status); operators/owners see full detail (surface, timing).
}

{
  "events": [],
  "sessions": []
}

{
  entityId:  string  // Canonical entity ID to grant operator access.
}

{
  "entityId": "entityId"
}

{
  granted:  boolean
  agentId:  string
  entityId:  string
}

{
  "granted": false,
  "agentId": "agentId",
  "entityId": "entityId"
}

{
  removed:  boolean
  agentId:  string
}

{
  "removed": false,
  "agentId": "agentId"
}

{
  name:  string  // Knowledge item name.
  content:  string  // Knowledge content.
  chatId?:  string  // Scope to a specific chat.
  entityId?:  string  // Associated entity.
  sourceType?:  "text" | "url" | "builtin" | "learned"  // How the knowledge was added.
  summary?:  string  // Short summary for listings.
}

{
  "name": "name",
  "content": "content",
  "chatId": "chatId",
  "entityId": "entityId",
  "sourceType": "sourceType",
  "summary": "summary"
}

{
  knowledge:  object[]
}

{
  "knowledge": []
}

{
  agentId:  string
  platform:  string
  workspaceId:  string
  excludedCategoryIds:  string[]
}

{
  "agentId": "agentId",
  "platform": "platform",
  "workspaceId": "workspaceId",
  "excludedCategoryIds": []
}

{
  excludedCategoryIds:  string[]  // Full set of excluded category ids (replaces the current set).
}

{
  "excludedCategoryIds": []
}

{
  agentId:  string
  platform:  string
  workspaceId:  string
  excludedCategoryIds:  string[]
}

{
  "agentId": "agentId",
  "platform": "platform",
  "workspaceId": "workspaceId",
  "excludedCategoryIds": []
}

{
  period:  string  // Billing period 'YYYY-MM'.
  responses:  number  // Delivered bot responses in the period (for the chat if chatId given, else the agent total).
  limit:  number  // Monthly response limit from the agent's plan (default 5000).
  plan:  string  // Plan name from the agent's plan (default 'creator').
}

{
  "period": "period",
  "responses": 0,
  "limit": 0,
  "plan": "plan"
}

{
  agentId:  string
  period:  string
  total:  object
  byThread:  object[]
  byChat:  object[]
  byModel:  object[]
}

{
  "agentId": "agentId",
  "period": "period",
  "total": null,
  "byThread": [],
  "byChat": [],
  "byModel": []
}

{
  configured:  boolean  // Whether the server has Stripe wired (secret key + price id).
  plan:  string  // Plan name from agent_plans, or null (free default).
  status:  string  // Stripe subscription status: active|trialing|past_due|canceled|… or null.
  subscribed:  boolean  // True when status is active or trialing.
  monthlyResponseLimit:  number  // Monthly response limit for the plan.
  currentPeriodEnd:  number  // Unix seconds the current period / access lasts until.
  hasStripeCustomer:  boolean  // Whether a Stripe Customer exists for this agent.
}

{
  "configured": false,
  "plan": "plan",
  "status": "status",
  "subscribed": false,
  "monthlyResponseLimit": 0,
  "currentPeriodEnd": 0,
  "hasStripeCustomer": false
}

{
  returnPath?:  string  // Console path to return to after checkout. Defaults to /<agentId>.
}

{
  "returnPath": "returnPath"
}

{
  url:  string  // Stripe Checkout URL to redirect the buyer to.
}

{
  "url": "url"
}

{
  returnPath?:  string  // Console path to return to after checkout. Defaults to /<agentId>.
}

{
  "returnPath": "returnPath"
}

{
  url:  string  // Stripe Billing Portal URL to manage the subscription.
}

{
  "url": "url"
}

{
  agentId:  string
  skills:  object[]
}

{
  "agentId": "agentId",
  "skills": []
}

{
  enabled:  boolean  // Target enabled state.
  chatId?:  string  // When present, writes a per-chat override (admin-gated). When absent, flips the row's own enabled flag (operator-gated).
}

{
  "enabled": false,
  "chatId": "chatId"
}

{
  name:  string
  enabled:  boolean
  scope:  "chat" | "agent"  // chat = per-chat override; agent = row-level flag.
}

{
  "name": "name",
  "enabled": false,
  "scope": "scope"
}

{
  deleted:  boolean
  name:  string
}

{
  "deleted": false,
  "name": "name"
}

{
  url:  string  // URL of the skill .md to fetch and install.
  chatId?:  string  // Scope the installed skill to a chat. Omit for agent-global (operator).
}

{
  "url": "url",
  "chatId": "chatId"
}

{
  title?:  string  // Thread title.
  id?:  string  // Custom thread ID (defaults to UUID).
  type?:  string  // Thread type (private or group).
  agentId?:  string  // Agent to assign to this thread.
}

{
  "title": "title",
  "id": "id",
  "type": "type",
  "agentId": "agentId"
}

{
  threads:  object[]
}

{
  "threads": []
}

{
  id:  string
  title:  string
  type:  string
  agentId:  string
  config:  object
  participants:  object[]
  lastMessageAt:  number
}

{
  "id": "id",
  "title": "title",
  "type": "type",
  "agentId": "agentId",
  "config": null,
  "participants": [],
  "lastMessageAt": 0
}

{
  deleted:  boolean
}

{
  "deleted": false
}

{
  agentId?:  string  // Override agent for config lookup.
  language?:  string  // ISO language code.
  replyMode?:  "social" | "quiet" | "silent"  // Reply mode.
  instructions?:  string  // Custom instructions.
  topicFocus?:  string  // Topic-scope: when set, the agent engages ONLY with messages on this topic here. null/empty clears the restriction.
  knowledgeMode?:  "open" | "grounded"  // Knowledge mode: open (free) or grounded (answer only from sources).
  allowedRoleIds?:  string[]  // Role whitelist: platform role ids allowed to engage. [] / null clears (everyone).
  substantiveSaturation?:  number  // Saturation cap override. null = inherit from chat/agent default.
  postStimulusDecay?:  number  // Post-stimulus decay multiplier override. null = inherit.
  threadId?:  string  // Sub-encounter id (Telegram topic, Discord thread). When set, overrides apply at thread level; omitted = chat level.
}

{
  "agentId": "agentId",
  "language": "language",
  "replyMode": "replyMode",
  "instructions": "instructions",
  "topicFocus": "topicFocus",
  "knowledgeMode": "knowledgeMode",
  "allowedRoleIds": [],
  "substantiveSaturation": 0,
  "postStimulusDecay": 0,
  "threadId": "threadId"
}

{
  configured:  boolean
}

{
  "configured": false
}

{
  kind:  "topic-seed" | "world-event" | "nudge"  // Stimulus type.
  text?:  string  // Prompt text the agents see.
  payload?:  object  // Structured envelope.
  source?:  string  // Origin tag for audit / dashboards.
  agentId?:  string  // Single-agent target; default = all agents in thread.
  priority?:  number  // Inbox priority.
}

{
  "kind": "kind",
  "text": "text",
  "payload": null,
  "source": "source",
  "agentId": "agentId",
  "priority": 0
}

{
  injected:  boolean
  threadId:  string
  inboxItemIds:  string[]
  agentIds:  string[]
}

{
  "injected": false,
  "threadId": "threadId",
  "inboxItemIds": [],
  "agentIds": []
}

{
  question:  string  // The test question to ask the agent.
}

{
  "question": "question"
}

{
  answer:  string  // The agent's answer.
  sources?:  string[]  // Knowledge sources the agent cited.
  usedWebSearch?:  boolean  // Whether web_search was used.
}

{
  "answer": "answer",
  "sources": [],
  "usedWebSearch": false
}

{
  agentId:  string  // Agent ID to add to thread.
}

{
  "agentId": "agentId"
}

{
  added:  boolean
  canonicalId:  string
}

{
  "added": false,
  "canonicalId": "canonicalId"
}

{
  removed:  boolean
}

{
  "removed": false
}

{
  threadId:  string
  items:  object[]
}

{
  "threadId": "threadId",
  "items": []
}

{
  instruction:  string
  cron:  string  // 5-field cron, e.g. "0 9 * * *" for daily at 09:00.
  timezone?:  string  // IANA timezone for the cron; defaults to UTC.
}

{
  "instruction": "instruction",
  "cron": "cron",
  "timezone": "timezone"
}

{
  deleted:  boolean
}

{
  "deleted": false
}

{
  threadId:  string
  admins:  object[]
}

{
  "threadId": "threadId",
  "admins": []
}

{
  threadId:  string
  events:  object[]
}

{
  "threadId": "threadId",
  "events": []
}

{
  threadId:  string
  roles:  object[]
}

{
  "threadId": "threadId",
  "roles": []
}

{
  threadId:  string
  messages:  object[]
  hasMore:  boolean
}

{
  "threadId": "threadId",
  "messages": [],
  "hasMore": false
}

data: {"type": "token", "text": "Hello"}
data: {"type": "done", "response": "Hello there", "responseType": "reply"}
data: {"type": "error", "message": "..."}
: heartbeat

{
  cancelled:  boolean
}

{
  "cancelled": false
}

{
  url:  string
  type:  string
  mimeType:  string
  filename:  string
  size:  number
}

{
  "url": "url",
  "type": "type",
  "mimeType": "mimeType",
  "filename": "filename",
  "size": 0
}

{
  threadId:  string
  users:  object[]
}

{
  "threadId": "threadId",
  "users": []
}

{
  threadId:  string
  userId:  string
  profile:  object
  profileNotes:  string
  notes:  string
  monthlyArc:  object[]
}

{
  "threadId": "threadId",
  "userId": "userId",
  "profile": null,
  "profileNotes": "profileNotes",
  "notes": "notes",
  "monthlyArc": []
}

{
  threadId:  string
  agentId:  string
  memberCount:  number
  members:  object[]
  privacy:  object
  notes:  object
}

{
  "threadId": "threadId",
  "agentId": "agentId",
  "memberCount": 0,
  "members": [],
  "privacy": null,
  "notes": null
}

{
  threadId:  string
  digests:  object[]
}

{
  "threadId": "threadId",
  "digests": []
}

{
  threadId:  string
  lastActiveAt:  number
  missed:  object[]
}

{
  "threadId": "threadId",
  "lastActiveAt": 0,
  "missed": []
}

{
  name:  string  // Knowledge item name.
  content?:  string  // Knowledge content. Optional for url sources (the daemon fetches the page).
  agentId?:  string  // Override agent for knowledge scope.
  sourceType?:  "url" | "text" | "file" | "learned" | "observed" | "skill" | "builtin"  // Source type.
  sourceUrl?:  string  // Source URL (required for url sources without content).
  summary?:  string  // Short summary.
}

{
  "name": "name",
  "content": "content",
  "agentId": "agentId",
  "sourceType": "sourceType",
  "sourceUrl": "sourceUrl",
  "summary": "summary"
}

{
  threadId:  string
  knowledge:  object[]
}

{
  "threadId": "threadId",
  "knowledge": []
}

{
  deleted:  boolean
}

{
  "deleted": false
}

{
  content?:  string  // New full content.
  summary?:  string  // New short summary.
}

{
  "content": "content",
  "summary": "summary"
}

{
  id:  string
  updated:  boolean
}

{
  "id": "id",
  "updated": false
}

{
  entities:  object[]
}

{
  "entities": []
}

{
  id:  string
  name:  string
  aliases:  object[]
  memory:  object
}

{
  "id": "id",
  "name": "name",
  "aliases": [],
  "memory": null
}

{
  threads:  object[]
}

{
  "threads": []
}

{
  code?:  string  // Link code from a link token.
  sourceEntity?:  string  // Source entity ID for direct merge.
  targetEntity?:  string  // Target entity ID for direct merge.
}

{
  "code": "code",
  "sourceEntity": "sourceEntity",
  "targetEntity": "targetEntity"
}

{
  mergedEntityId:  string
  aliasCount:  number
}

{
  "mergedEntityId": "mergedEntityId",
  "aliasCount": 0
}

{
  userId:  string
  profile:  object
  profileNotes:  string
  globalNotes:  string
  memory:  object[]
}

{
  "userId": "userId",
  "profile": null,
  "profileNotes": "profileNotes",
  "globalNotes": "globalNotes",
  "memory": []
}

{
  keepId:  string  // Entity ID to keep.
  mergeId:  string  // Entity ID to merge into keepId.
}

{
  "keepId": "keepId",
  "mergeId": "mergeId"
}

{
  merged:  boolean
  keepId:  string
  mergedId:  string
  operationId:  string
}

{
  "merged": false,
  "keepId": "keepId",
  "mergedId": "mergedId",
  "operationId": "operationId"
}

{
  entityId:  string
  displayName:  string
  isAnonymous:  boolean
  agentId:  string
  threads:  object[]
  aliases:  object[]
}

{
  "entityId": "entityId",
  "displayName": "displayName",
  "isAnonymous": false,
  "agentId": "agentId",
  "threads": [],
  "aliases": []
}

{
  agents:  object[]
}

{
  "agents": []
}

{
  name:  string  // Display name.
  personality?:  string  // The LLM persona (free text). Optional - falls back to a generic character.
  description?:  string  // One-line tagline for hub cards.
}

{
  "name": "name",
  "personality": "personality",
  "description": "description"
}

{
  name:  string  // Draft display name.
  personality?:  string  // The draft persona (free text). Falls back to the default character.
  history?:  object[]  // Prior turns of this preview chat (most recent kept).
  message:  string  // The visitor's message to the draft.
}

{
  "name": "name",
  "personality": "personality",
  "history": [],
  "message": "message"
}

{
  reply:  string
}

{
  "reply": "reply"
}

{
  agentId?:  string  // Agent context for the link's landing page. Defaults to the caller's session agent.
}

{
  "agentId": "agentId"
}

{
  platform:  string  // The platform/source of the alias (e.g. telegram, discord).
  platformId:  string  // The user's id on that platform (the alias sourceId).
}

{
  "platform": "platform",
  "platformId": "platformId"
}

{
  ok:  boolean
}

{
  "ok": false
}

object

{}

data: {"type": "token", "text": "Hello"}
data: {"type": "done", "response": "Hello there", "responseType": "reply"}
data: {"type": "error", "message": "..."}
: heartbeat

object

{}

data: {"type": "token", "text": "Hello"}
data: {"type": "done", "response": "Hello there", "responseType": "reply"}
data: {"type": "error", "message": "..."}
: heartbeat

data: {"type": "token", "text": "Hello"}
data: {"type": "done", "response": "Hello there", "responseType": "reply"}
data: {"type": "error", "message": "..."}
: heartbeat

{
  agentId:  string
  name:  string
}

{
  "agentId": "agentId",
  "name": "name"
}

{
  ok:  boolean
}

{
  "ok": false
}