Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app addAppUserGroupReportPermission addAppUserGroupToExternalApplication addUsersToAppUserGroup createAppUserGroup createExternalApplication deleteAppUserGroup deleteExternalApplication describeExternalApplication getAppUserGroup inviteUsersToAppUserGroup listExternalApplications removeAppUserGroupFromExternalApplication removeAppUserGroupReportPermission removeUsersFromAppUserGroup updateExternalApplication feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

describeExternalApplication GET

Copy GET

Describes an External Application.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	externalApplicationId	str	The ID of the External Application.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY

TYPE

DESCRIPTION

success

Boolean

true if the call succeeded, false if there was an error

result

ExternalApplication

KEY	TYPE	Description
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.
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.
isCustomizable	bool	Whether the external application is customizable.
isDeprecated	bool	Whether the external application is deprecated. Only applicable for system created bots. Deprecated external applications will not show in the UI.

Exceptions:

TYPE	WHEN
DataNotFoundError	`externalApplicationId` is not found.

Language: