abacusai.external_application

Classes

ExternalApplication

An external application.

Module Contents

class abacusai.external_application.ExternalApplication(client, name=None, externalApplicationId=None, deploymentId=None, description=None, logo=None, theme=None, userGroupIds=None, useCase=None, isAgent=None, createdAt=None, status=None, deploymentConversationRetentionHours=None, managedUserService=None, predictionOverrides=None, isSystemCreated=None, isVirtualModel=None, isCustomizable=None, browserAgentTiers=None, browserAgentUnavailableMessage=None, browserAgentActionSafetyAvailable=None, isDeprecated=None, isVisible=None, hasThinkingOption=None, hasFastMode=None, hasEffortOption=None, availableEffortLevels=None, onlyImageGenEnabled=None, projectId=None, isCodellmChatmodeSupported=None, urlPath=None, deepagentEffortModes=None, defaultDeepagentEffortMode=None, deepagentDefaultFromGroup=None, channelHandle=None)

Bases: abacusai.return_class.AbstractApiClass

An external application.

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • name (str) – The name of the external application.

  • externalApplicationId (str) – The unique identifier of the external application.

  • deploymentId (str) – The deployment id associated with the external application.

  • description (str) – The description of the external application.

  • logo (str) – The logo.

  • theme (dict) – The theme used for the External Application.

  • userGroupIds (list) – A list of App User Groups with access to this external application

  • useCase (str) – Use Case of the project of this deployment

  • isAgent (bool) – Whether the external application is an agent.

  • createdAt (str) – When the external application was created.

  • status (str) – The status of the deployment.

  • deploymentConversationRetentionHours (int) – The retention policy for the external application.

  • managedUserService (str) – The external service that is managing the user accounts.

  • predictionOverrides (dict) – The prediction overrides for the external application.

  • isSystemCreated (bool) – Whether the external application is system created.

  • isVirtualModel (bool) – Whether the entry is a virtual model listed under a base router application rather than an external application of its own.

  • isCustomizable (bool) – Whether the external application is customizable.

  • browserAgentTiers (list) – The browser extension agent tiers the organization can serve, each with its tier, label, the model it resolves to and the screen frame that model grounds on. Only set when the listing is requested with browser_agent_tiers.

  • browserAgentUnavailableMessage (str) – Why no browser extension agent tier is available, when browser_agent_tiers is empty.

  • browserAgentActionSafetyAvailable (bool) – Whether the browser extension’s Auto mode (a safety check on each page action) has a model the organization’s policy permits. Only set when the listing is requested with browser_agent_tiers.

  • isDeprecated (bool) – Whether the external application is deprecated.

  • isVisible (bool) – Whether the external application should be shown in the dropdown.

  • hasThinkingOption (bool) – Always false; kept for native builds that still read it. Effort is the only reasoning control.

  • hasFastMode (bool) – Whether the external application has fast mode.

  • hasEffortOption (bool) – Whether the external application has an effort option.

  • availableEffortLevels (list) – List of available effort levels for the model (e.g. [‘low’, ‘high’]).

  • onlyImageGenEnabled (bool) – Whether to LLM only allows image generation.

  • projectId (str) – The project id associated with the external application.

  • isCodellmChatmodeSupported (bool) – Whether the external application is codellm chatmode supported

  • urlPath (str) – A short URL-friendly path for the external application. Only set for system created bots.

  • deepagentEffortModes (list) – List of available effort modes for the Deep Agent. Only applicable for super agent applications.

  • defaultDeepagentEffortMode (str) – The default effort mode for the Deep Agent. Only applicable for super agent applications.

  • deepagentDefaultFromGroup (bool) – Whether default_deepagent_effort_mode comes from an admin-set user group default, which seeds new conversations ahead of the user’s remembered effort pick. Only applicable for super agent applications.

  • channelHandle (str) – The @handle that reaches this application from a personal agent’s messaging channel.

name = None
external_application_id = None
deployment_id = None
description = None
theme = None
user_group_ids = None
use_case = None
is_agent = None
created_at = None
status = None
deployment_conversation_retention_hours = None
managed_user_service = None
prediction_overrides = None
is_system_created = None
is_virtual_model = None
is_customizable = None
browser_agent_tiers = None
browser_agent_unavailable_message = None
browser_agent_action_safety_available = None
is_deprecated = None
is_visible = None
has_thinking_option = None
has_fast_mode = None
has_effort_option = None
available_effort_levels = None
only_image_gen_enabled = None
project_id = None
is_codellm_chatmode_supported = None
url_path = None
deepagent_effort_modes = None
default_deepagent_effort_mode = None
deepagent_default_from_group = None
channel_handle = 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

add_developers_to()

Adds a permission for the platform App User Group to access an External Application.

Parameters:

external_application_id (str) – The ID of the External Application.

remove_developers_from()

Removes a permission for the platform App User Group to access an External Application.

Parameters:

external_application_id (str) – The ID of the External Application.

update(name=None, description=None, theme=None, deployment_id=None, deployment_conversation_retention_hours=None, reset_retention_policy=False, voice_config=None, channel_handle=None, reset_channel_handle=False)

Updates an External Application.

Parameters:

  • name (str) – The name of the External Application.

  • description (str) – The description of the External Application. This will be shown to users when they access the External Application.

  • theme (dict) – The visual theme of the External Application.

  • deployment_id (str) – The ID of the deployment to use.

  • deployment_conversation_retention_hours (int) – The number of hours to retain the conversations for.

  • reset_retention_policy (bool) – If true, the retention policy will be removed.

  • voice_config (dict) – Voice settings, merged into the stored settings; a key set to null is removed. Key: voice_style (an internal style id, 1 to 9, resolved to the active provider’s voice at call time).

  • channel_handle (str) – The @handle that reaches this application from a personal agent’s messaging channels (2 to 24 letters, digits or underscores; unique in the organization).

  • reset_channel_handle (bool) – If true, the @handle is removed.

Returns:

The updated External Application.

Return type:

ExternalApplication

refresh()

Calls describe and refreshes the current object’s fields

Returns:

The current object

Return type:

ExternalApplication

describe()

Describes an External Application.

Parameters:

external_application_id (str) – The ID of the External Application.

Returns:

The External Application.

Return type:

ExternalApplication

delete()

Deletes an External Application.

Parameters:

external_application_id (str) – The ID of the External Application.