CreateAgent-阿里云帮助中心

Create custom Agent

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

eventbridge:CreateAgent

create

*全部资源

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	Agent name	my-agent
Description	string	No	Description of the event bus	连接配置描述信息
Prompt	string	No	You are an IoT data analysis assistant...	我想要她，你这样增加请求头获取用户IP CF-Connecting-IP%3B
Metadata	object	No	Associated metadata
Attachments	array<object>	No	Array of bound metadata objects
	object	No	Bound metadata object
MimeType	string	No	Type of the bound metadata object	inner-resource/event-table
Arn	string	No	ARN of the bound metadata object	acs:eventbridge:cn-hangzhou:12345:eventhouse/system-rocketmq/namespace/rmq-cn-XXX/table/order

Response elements

Element	Type	Description	Example
	object	Returned result
Message	string	Error message.	Agent with name 'XXX' already exists for account 12345
RequestId	string	Request ID	B896B484-XXXXXX-DD0E5C361108
Data	object	Returned data.
AgentArn	string	Agent ARN	acs:eventbridge:{region}:{accountId}:agent/{agentName}
Code	string	API return code: Success: indicates success. Others: indicates an error code. For details about error codes, see Error Codes.	Success
Success	boolean	Whether the request was successful. The return values are as follows: true: the request was successful. false: the request failed.	true

Examples

Success response

JSON format

{
  "Message": "Agent with name 'XXX' already exists for account 12345",
  "RequestId": "B896B484-XXXXXX-DD0E5C361108",
  "Data": {
    "AgentArn": "acs:eventbridge:{region}:{accountId}:agent/{agentName} "
  },
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.