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, name=None, description=None, instructions=None, personality=None, memory=None, avatar=None, status=None, lifecycle=None, deploymentConversationId=None, externalApplicationId=None, lastMessagePreview=None, lastMessageAt=None, unreadCount=None, createdAt=None, schedule=None, tasks=None, channels=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.

  • 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.

  • 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); _describeBot only.

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

bot_id = None
name = None
description = None
instructions = None
personality = None
memory = None
avatar = None
status = None
lifecycle = None
deployment_conversation_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
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