ListDigitalEmployees - STAROps - Alibaba Cloud Documentation Center

Lists digital employees.

Operation description

Lists digital employees.

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

starops:ListDigitalEmployees

list

*DigitalEmployee

acs:starops:{#regionId}:{#accountId}:digitalemployee/*

None

Request syntax

GET /digital-employee HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
maxResults	integer	No	The page size. Default value: 20. Maximum value: 100.	10
nextToken	string	No	The token for the next query.	xxxxxx
name	string	No	The name of the digital employee.	test
employeeType	string	No	The type of the digital employee.	custom
displayName	string	No	Filters digital employees by channel type. If this parameter is not specified, the default channel is used.	default
tags	array	No	The display name of the digital employee.	test
	Tag	No	The tags.
resourceGroupId	string	No	The tags.	rg-ae******ey
		No	The resource group ID.	rg-ae******ey

Response elements

Element	Type	Description	Example
	object
digitalEmployees	array<object>	The list of digital employees.
	array<object>	The digital employee.
attributes	object	The attributes.
	string
channel	string	The channel type of the digital employee.	default
createTime	string	The creation time.	2025-11-04T08:08:57Z
defaultRule	string	The default rule of the digital employee.	test
description	string	The description of the digital employee.	test
displayName	string	The display name of the digital employee.	test
employeeType	string	The type of the digital employee.	custom
knowledges	object	The list of knowledge bases.
bailian	array<object>	The list of Bailian knowledge bases.
	object	The list of Bailian knowledge bases.
attributes	string	The knowledge base attributes.	test
indexId	string	The Bailian index ID.	index-xxxx
region	string	The region of the knowledge base.	cn-beijing
workspaceId	string	The Bailian workspace ID.	llm-xxxx
sop	array<object>	The list of SOP knowledge bases.
	object	The SOP knowledge base.	{ "type": "oss", "basePath": "docs/", "region": "cn-hangzhou", "endpoint": "oss-cn-hangzhou.aliyuncs.com", "bucket": "my-sop-bucket", "description": "sls sop" }
name	string	The name of the digital employee.	test
resourceGroupId	string	The resource group ID.	rg-ae******ey
roleArn	string	The ARN of the RAM role.	acs:ram::12345678912:role/testrole
tags	array	The tags.
	Tag	The tags.
updateTime	string	The update time.	2025-05-07T02:26:01Z
maxResults	integer	The maximum number of results returned.	10
nextToken	string	The token for the next query.	xxxxx
requestId	string	The request ID.	8FDE2569-626B-5176-9844-28877A*****
total	integer	The total number of records.	56

Examples

Success response

JSON format

{
  "digitalEmployees": [
    {
      "attributes": {
        "key": ""
      },
      "channel": "default",
      "createTime": "2025-11-04T08:08:57Z\n",
      "defaultRule": "test",
      "description": "test",
      "displayName": "test",
      "employeeType": "custom",
      "knowledges": {
        "bailian": [
          {
            "attributes": "test",
            "indexId": "index-xxxx\n",
            "region": "cn-beijing\n",
            "workspaceId": "llm-xxxx\n"
          }
        ],
        "sop": [
          {
            "type": "oss",
            "basePath": "docs/",
            "region": "cn-hangzhou",
            "endpoint": "oss-cn-hangzhou.aliyuncs.com",
            "bucket": "my-sop-bucket",
            "description": "sls sop"
          }
        ]
      },
      "name": "test",
      "resourceGroupId": "rg-ae******ey",
      "roleArn": "acs:ram::12345678912:role/testrole\n",
      "tags": [
        {
          "key": "test-key",
          "value": "test-value"
        }
      ],
      "updateTime": "2025-05-07T02:26:01Z\n"
    }
  ],
  "maxResults": 10,
  "nextToken": "xxxxx",
  "requestId": "8FDE2569-626B-5176-9844-28877A*****\n",
  "total": 56
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.