ListCustomAgents - ListCustomAgents-阿里云帮助中心

Retrieves a paginated list of custom agents.

Operation description

Request

Search keyword: Use the Q parameter to perform a fuzzy search by agent name.
Visibility level filtering: Use the Visibility parameter to filter results by visibility level, such as TENANT, PROJECT, or USER.
Paging information: Use the MaxResults and NextToken parameters to implement paginated queries. NextToken retrieves the next page of results.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The maximum number of entries to return in this request.	20
NextToken	string	No	The pagination token. Leave this parameter empty for the first request. For subsequent requests, set this parameter to the `NextToken` value returned in the previous response to retrieve the next page.	12345
Q	string	No	The search keyword used for fuzzy matching by agent name.	analysis
Visibility	array	No	Filters results by visibility level. You can specify multiple values.	-
	string	No	The visibility level.	TENANT

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries that match the conditions.	100
MaxResults	integer	The maximum number of entries returned in this response.	20
NextToken	string	The token for the next page. An empty value indicates that no more pages are available.	5
Agents	array	The list of custom agents.
	object	The agent list.
Name	string	The agent name.	my-agent
DisplayName	string	The display name.	My Assistant
Description	string	The description.	Data analysis assistant
CreatorId	string	The creator ID.	123456
ModifierId	string	The ID of the user who last modified the agent.	123456
Visibility	string	The visibility level.	TENANT
GmtCreateTime	string	The creation time, in millisecond-precision timestamp format.	1780555634000
GmtModifiedTime	string	The last modification time, in millisecond-precision timestamp format.	1780555634000

Examples

Success response

JSON format

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "PagingInfo": {
    "TotalCount": 100,
    "MaxResults": 20,
    "NextToken": "5",
    "Agents": [
      {
        "Name": "my-agent",
        "DisplayName": "My Assistant",
        "Description": "Data analysis assistant",
        "CreatorId": "123456",
        "ModifierId": "123456",
        "Visibility": "TENANT",
        "GmtCreateTime": "1780555634000",
        "GmtModifiedTime": "1780555634000"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.