StartAIAgentInstance-Intelligent Media Services(IMS)-阿里云帮助中心

Starts an AI agent instance configured in IMS.

Operation description

Use this API to start a configured AI agent instance and engage it in a conversation. You must provide the agent ID (AIAgentId) and runtime configuration (RuntimeConfig). Optional parameters include the template configuration (TemplateConfig) and user-defined information (UserData). After the agent instance is successfully started, a unique InstanceId is returned for subsequent tracking or operations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:StartAIAgentInstance

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AIAgentId	string	Yes	The ID of the agent configured in the IMS console.	39f8e0bc005e4f309379701645f4****
RuntimeConfig	AIAgentRuntimeConfig	Yes	The configuration required for the agent runtime.
AgentConfig	AIAgentConfig	No	The agent template configuration. The specified configuration is merged and updated with the agent template configuration in the console. If this parameter is not specified, the default configurations of the agent in the console are used. Note Compatible with TemplateConfig rules: Fields in AgentConfig take precedence. If TemplateConfig contains fields that are not specified in AgentConfig, the fields in TemplateConfig are used. Use AgentConfig instead of TemplateConfig.
UserData	string	No	The user-defined information.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	No	The unique identifier of the conversation. Default value: none.	f213fbc005e4f309379701645f4****
ChatSyncConfig	object	No	The configuration for synchronizing chat history.
IMAIAgentId	string	No	The ID of the IM agent.	****005e4f309379701645f4**
ReceiverId	string	No	The ID of the receiving user.	4167626d312034b2b1c3b7f2f3e41884
TemplateConfig `deprecated`	AIAgentTemplateConfig	No	The agent template configuration. The specified configuration is merged and updated with the agent template configuration in the console. If this parameter is not specified, the default configurations of the agent in the console are used. Note Agent template configuration. [Deprecated] For more information, see the AgentConfig field.

Response elements

Element	Type	Description	Example
	object	Schema of Response
InstanceId	string	The unique ID of the agent instance.	39f8e0bc005e4f309379701645f4****
RequestId	string	The request ID.	7B117AF5-2A16-412C-B127-FA6175ED1AD0

Examples

Success response

JSON format

{
  "InstanceId": "39f8e0bc005e4f309379701645f4****",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.