Agents, modules & tools

Methods for registering and managing agents, agent pools, modules, functions, and tools on the Istari Digital Platform.

All methods are available on the Client instance. Parameters marked (required) must be provided. See Enums for valid enum values and Pagination for page/size defaults.

Agents

register_agent()

Registers a new agent.

• Parameters:

  • new_agent (NewAgent) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

get_agent()

Gets an agent by id.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

list_agents()

Lists all agents a user has access to.

• Parameters:

  • agent_version (str) – Filter by the agent version
  • host_os (str) – Filter by the host OS
  • updated_since (datetime) – Filter by last update time of agent
  • module_name (str) – Filter by name of module loaded on the agent
  • module_version (str) – Filter by version of module loaded on the agent
  • status_name (AgentStatusName) – Filter by the agent status name. See AgentStatusName for valid values.
  • tenant_id (str) – Filter by tenant ID
  • all_tenants (bool) – Show agents across all tenants (customer admin only)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAgent

get_agent_display_name()

Gets an agent’s display name.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentDisplayName

update_agent_display_name()

Updates an agent’s display name.

• Parameters:

  • agent_id (str) – The ID of the agent to update. (required)
  • new_agent_display_name (NewAgentDisplayName) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

get_agent_status()

Gets an agent’s status.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentStatus

update_agent_status()

Updates an agent’s status.

• Parameters:

  • agent_id (str) – The ID of the agent to update. (required)
  • new_agent_status (NewAgentStatus) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

get_agent_available_jobs()

Gets the list of available jobs for an agent.

• Parameters:

  • agent_id (str) – The identifier for the agent (required)
  • page (int) – Page number
  • size (int) – Page size
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageJob

get_agent_modules()

Gets an agent’s loaded modules.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentModules

update_agent_modules()

Updates an agent’s loaded modules.

• Parameters:

  • agent_id (str) – The ID of the agent to update. (required)
  • new_agent_module_version (List [**NewAgentModuleVersion ]) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

update_agent_information()

Updates an agent’s information.

• Parameters:

  • agent_id (str) – The ID of the agent to update. (required)
  • new_agent_information (NewAgentInformation) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

get_agent_status_retention_policy()

Gets status retention policy duration in the registry for all agents

• Parameters: http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentStatusRetentionDuration

set_agent_status_retention_policy()

Sets status retention policy duration in the registry for all agents

• Parameters:

  • new_agent_status_retention_duration (NewAgentStatusRetentionDuration) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentStatusRetentionDuration

list_agent_status_history()

Lists an agent’s status history.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAgentStatus

Agent pools

create_agent_pool()

Creates a new agent pool.

• Parameters:

  • new_agent_pool (NewAgentPool) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

get_agent_pool()

Gets an agent pool by id.

• Parameters:

  • agent_pool_id (str) – The ID of the agent pool to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

list_agent_pools()

Lists all agent pools a user has access to.

• Parameters:

  • all_users (bool) – Show agent pools owned by all users (requires admin privileges)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAgentPool

update_agent_pool()

Updates an agent pool’s information.

• Parameters:

  • agent_pool_id (str) – The id of the agent pool to update (required)
  • new_agent_pool (NewAgentPool) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

delete_agent_pool()

Deletes an agent pool.

• Parameters:

  • agent_pool_id (str) – The ID of the agent pool to delete. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

update_agent_pool_agent()

Adds or updates an agent’s membership in an agent pool.

• Parameters:

  • agent_pool_id (str) – The id of the agent pool to update (required)
  • new_agent_pool_agent_membership (NewAgentPoolAgentMembership) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

update_agent_pool_user()

Adds or updates a user’s membership in an agent pool.

• Parameters:

  • agent_pool_id (str) – The id of the agent pool to update (required)
  • new_agent_pool_user_membership (NewAgentPoolUserMembership) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

list_agent_pool_agents()

Lists agent memberships in detail for an agent pool.

• Parameters:

  • agent_pool_id (str) – The id of the agent pool to list agents for (required)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAgentPoolAgentMembershipWithAgent

list_agent_pool_users()

Lists user memberships in detail for an agent pool.

• Parameters:

  • agent_pool_id (str) – The id of the agent pool to list users for (required)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAgentPoolUserMembershipWithUser

remove_agent_pool_agent()

Deletes an agent’s membership in an agent pool.

• Parameters:

  • agent_pool_id (str) – The ID of the agent pool to remove the agent from. (required)
  • agent_id (str) – The ID of the agent to delete. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

remove_agent_pool_user()

Deletes a user’s membership in an agent pool.

• Parameters:

  • agent_pool_id (str) – The ID of the agent pool to remove the user from. (required)
  • user_id (str) – The ID of the user to delete. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentPool

Modules

create_module()

Creates a new module.

• Parameters:

  • new_module_manifest (NewModuleManifest) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Module

get_module()

Gets a module by id

• Parameters:

  • module_id (str) – The id of the module to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Module

list_modules()

Lists all modules a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageModule

deprecate_module()

Deprecates all versions of a module.

• Parameters:

  • module_id (str) – The id of the module to deprecate (required)
  • deprecation_reason (DeprecationReason) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Module

get_module_version()

Gets a module version by id.

• Parameters:

  • module_version_id (str) – The id of the module version to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleVersion

list_module_versions()

List all module versions a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageModuleVersion

deprecate_module_version()

Deprecates a module version.

• Parameters:

  • module_version_id (str) – The id of the module version to deprecate (required)
  • deprecation_reason (DeprecationReason) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleVersion

Functions

get_function()

Gets a function by id.

• Parameters:

  • function_id (str) – ID of the function to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FunctionVersion

get_function_schema()

Gets a function schema by id.

• Parameters:

  • function_schema_id (str) – ID of the function schema to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FunctionSchema

list_functions()

Lists all functions a user has access to.

• Parameters:

  • name (str) – Filter functions by name
  • module_version (str) – Filter functions by module version
  • tool (str) – Filter functions by tool name
  • tool_version (str) – Filter functions by tool version
  • operating_system (str) – Filter functions by operating system
  • input_extension (str) – Filter functions by input file extension
  • input_user_models (UserModelInputs) – Filter functions by input user models. One of: single, multiple.
  • status (UsabilityStatusParams) – Filter functions by usability status. One of: supported, deprecated, all. Default: supported.
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageFunctionVersion

Tools and operating systems

create_tool()

Creates a new tool.

• Parameters:

  • new_tool (NewTool) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Tool

get_tool()

Gets a tool by id

• Parameters:

  • tool_id (str) – The ID of the tool to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Tool

list_tools()

List all tools a user has access to

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • include (List [**ToolInclude ]) – Whether to include functions in response. Values: functions, function_versions.
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageTool

update_tool()

Updates a tool.

• Parameters:

  • tool_id (str) – The ID of the tool to update. (required)
  • update_tool (UpdateTool) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Tool

create_tool_versions()

Creates a new tool version.

• Parameters:

  • tool_id (str) – The ID of the tool to add a version to. (required)
  • new_tool_version (NewToolVersion) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ToolVersion

get_tool_version()

Gets a tool version by id.

• Parameters:

  • tool_version_id (str) – The tool version ID to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ToolVersion

list_tool_versions()

Lists all tool versions a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageToolVersion

create_author()

Creates a new author.

• Parameters:

  • new_module_author (NewModuleAuthor) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleAuthor

get_author()

Gets an author by id.

• Parameters:

  • author_id (str) – The author ID to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleAuthor

list_authors()

Lists all authors a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageModuleAuthor

update_author()

Updates an author.

• Parameters:

  • author_id (str) – The author ID to update. (required)
  • new_module_author (NewModuleAuthor) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleAuthor

create_operating_system()

Creates a new operating system.

• Parameters:

  • new_operating_system (NewOperatingSystem) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: OperatingSystem

get_operating_system()

Gets an operating system by id.

• Parameters:

  • operating_system_id (str) – The operating system ID to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: OperatingSystem

list_operating_systems()

Lists all operating systems a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageOperatingSystem

update_operating_system()

Updates an existing operating system.

• Parameters:

  • operating_system_id (str) – The id of the operating system to update. (required)
  • new_operating_system (NewOperatingSystem) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: OperatingSystem