UpdateCustomAgent-阿里云帮助中心

Updates a 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

rdsai:UpdateCustomAgent

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
CustomAgentId	string	Yes	The agent ID.	ebe44453-3b41-4c74-94d1-01d088d7****
Name	string	No	The name of the custom agent.	Query instance list agent
SystemPrompt	string	No	The system prompt.	I am your custom agent for querying the instance list
EnableTools	boolean	No	Specifies whether to enable tools.	true
Tools	array	No	The tool information.
	string	No	The tool details.	[describe_db_instances,describe_db_instance_attribute]
SkillIds	array	No	The list of associated skill IDs.
	string	No

Response elements

Element	Type	Description	Example
	object	The object.
EnableTools	string	Specifies whether to enable tools.	true
Id	string	The agent ID.	82cf3d62-0add-47bd-869f-877131f7****
Name	string	The name of the custom agent.	Query instance list agent
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****
Skills	array<object>	The list of associated skill details.
	object
Description	string	The skill description.	SQL query optimization skill
Id	string	The unique identifier of the skill.	82cf3d62-0add-47bd-869f-877131f7****
Name	string	The skill name.	query-optimization
SkillType	string	The skill type.	user
SystemPrompt	string	The system prompt.	I am your custom agent for querying the instance list
Tools	array	The tool information.
	string	The tool details.	[describe_db_instances,describe_db_instance_attribute]

Examples

Success response

JSON format

{
  "EnableTools": "true",
  "Id": "82cf3d62-0add-47bd-869f-877131f7****",
  "Name": "Query instance list agent",
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Skills": [
    {
      "Description": "SQL query optimization skill",
      "Id": "82cf3d62-0add-47bd-869f-877131f7****",
      "Name": "query-optimization",
      "SkillType": "user"
    }
  ],
  "SystemPrompt": "I am your custom agent for querying the instance list",
  "Tools": [
    "[describe_db_instances,describe_db_instance_attribute]\n"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.
403	SkillNotBelongToUser	One or more skills are not accessible to the current user.	The current user does not have permission to access one or more skills.
404	CustomAgentNotFound	The custom agent was not found or is not accessible.	The custom smart body does not exist or the current user does not have access.
409	CustomAgentNameDuplicated	A custom agent with the same name already exists.	A custom agent with the same name already exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.