abacusai.bot

Classes

Bot

A persistent chat bot (long-running agent the user messages like a contact)

Module Contents

class abacusai.bot.Bot(client, botId=None, ownerUserId=None, isOwner=None, canEdit=None, ownerEmail=None, name=None, description=None, instructions=None, personality=None, memory=None, avatar=None, status=None, lifecycle=None, deploymentConversationId=None, chatllmProjectId=None, externalApplicationId=None, lastMessagePreview=None, lastMessageAt=None, unreadCount=None, createdAt=None, schedule=None, tasks=None, channels=None, learnedPersonality=None, learnedInstructions=None, profileHistory=None, selfReview=None, playbooks=None, proactiveBudget=None, chattyGreetings=None, quietHours=None, agentNetwork=None, pushNotificationsEnabled=None)

Bases: abacusai.return_class.AbstractApiClass

A persistent chat bot (long-running agent the user messages like a contact)

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • botId (str) – The id of the bot.

  • ownerUserId (str) – The user id of the agent’s owner.

  • isOwner (bool) – Whether the caller owns the agent; False for a teammate’s agent shared with the caller (via its conversation).

  • canEdit (bool) – Whether the caller may edit, delete and re-share the agent (the owner, a teammate shared with the editor role, or any teammate with conversation access to the agent’s project).

  • ownerEmail (str) – The owner’s email; shared agents in _listBots only.

  • name (str) – The name of the bot.

  • description (str) – The description of the bot.

  • instructions (str) – The user-provided instructions/persona for the bot.

  • personality (str) – The bot’s self-maintained personality (tone, voice, quirks).

  • memory (str) – The bot’s persistent memory notes.

  • avatar (str) – The avatar for the bot.

  • status (str) – The current activity status of the bot (IDLE, WORKING, WAITING_FOR_USER).

  • lifecycle (str) – The lifecycle of the bot (ACTIVE, ARCHIVED).

  • deploymentConversationId (str) – The bot’s persistent conversation id.

  • chatllmProjectId (str) – The project the agent belongs to (its files, skills and instructions apply, and every teammate who can see the project sees it and every project editor may edit it); None for a personal agent outside a project.

  • externalApplicationId (str) – The external application id associated with the bot.

  • lastMessagePreview (str) – A preview of the last message in the bot’s conversation.

  • lastMessageAt (int) – Unix timestamp of the last message in the bot’s conversation.

  • unreadCount (int) – The number of unread bot messages.

  • createdAt (int) – Unix timestamp of when the bot was created.

  • schedule (dict) – The bot’s heartbeat schedule (frequency/time/day_of_week/timezone), if any.

  • tasks (list) – The bot’s named scheduled tasks (daemon_task_id/name/prompt/schedule; event tasks also carry webhook_url); _describeBot only.

  • channels (dict) – The bot’s configured messaging channels keyed by channel name; secret values are masked.

  • learnedPersonality (str) – Personality the bot learned on its own from user feedback; _describeBot only.

  • learnedInstructions (str) – Rules the bot learned on its own from user feedback; _describeBot only.

  • profileHistory (list) – Changelog of the bot’s self-edits to the learned fields (t/field/old/new, chronological; undo entries flagged); _describeBot only.

  • selfReview (dict) – Latest self-review state (n/last_t/score/note); _describeBot only.

  • playbooks (list) – Reusable procedures the bot saved (name/body/t/uses/wins/losses, chronological); _describeBot only.

  • proactiveBudget (int) – User-set daily cap on proactive messages from high-frequency fires (hourly heartbeat + minute tasks); None when uncapped; _describeBot only.

  • chattyGreetings (bool) – Whether the agent says a short personal hello when the owner opens its chat in the web UI (default True); _describeBot only.

  • quietHours (dict) – {‘start’: ‘HH:MM’, ‘end’: ‘HH:MM’} window (agent timezone) in which high-frequency fires stay silent; None when the owner turned quiet hours off; _describeBot only.

  • agentNetwork (dict) – Agent-to-agent messaging state (discoverable/own_agents/contacts); _describeBot only.

  • pushNotificationsEnabled (bool) – Whether the agent may send mobile push notifications (the agent conversation’s own switch); _describeBot only.

bot_id = None
owner_user_id = None
is_owner = None
can_edit = None
owner_email = None
name = None
description = None
instructions = None
personality = None
memory = None
avatar = None
status = None
lifecycle = None
deployment_conversation_id = None
chatllm_project_id = None
external_application_id = None
last_message_preview = None
last_message_at = None
unread_count = None
created_at = None
schedule = None
tasks = None
channels = None
learned_personality = None
learned_instructions = None
profile_history = None
self_review = None
playbooks = None
proactive_budget = None
chatty_greetings = None
quiet_hours = None
agent_network = None
push_notifications_enabled = None
deprecated_keys
__repr__()
to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict