StartAIAgentInstance - Intelligent Media Services - Alibaba Cloud Documentation Center

Start an AI agent instance configured in IMS.

Operation description

You can use this API to start a configured AI agent instance and join it to a chat. Specify the agent ID (AIAgentId), runtime configuration (RuntimeConfig), and optionally a template configuration (TemplateConfig) and user-defined data (UserData). After the agent instance starts successfully, the API returns a unique InstanceId for tracking or further 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 agent ID configured in the IMS console.	39f8e0bc005e4f309379701645f4****
RuntimeConfig	AIAgentRuntimeConfig	Yes	The configuration required for the agent at runtime.
AgentConfig	AIAgentConfig	No	The agent template configuration. Values you provide merge with the template configuration set in the console. If you omit this parameter, the agent uses its default configuration from the console. Note This field is compatible with TemplateConfig. Fields in AgentConfig take precedence. If TemplateConfig contains fields not defined in AgentConfig, those fields are used. Use AgentConfig instead of TemplateConfig.
UserData	string	No	User-defined data.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	No	A unique identifier for the chat session. This parameter is optional.	f213fbc005e4f309379701645f4****
ChatSyncConfig	object	No	The chat history synchronization configuration.
IMAIAgentId	string	No	The IM agent ID.	****005e4f309379701645f4**
ReceiverId	string	No	The receiver user ID.	4167626d312034b2b1c3b7f2f3e41884
TemplateConfig `deprecated`	AIAgentTemplateConfig	No	The agent template configuration. Values you provide merge with the template configuration set in the console. If you omit this parameter, the agent uses its default configuration from the console. Note The agent template configuration. This field is deprecated. See the AgentConfig field.

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.