ListDigitalEmployees - STAROps - Alibaba Cloud Documentation Center

Returns a list of 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 number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	10
nextToken	string	No	The token that is used to retrieve the next page of results.	xxxxxx
name	string	No	The name of the digital employee.	test
employeeType	string	No	The type of the digital employee.	custom
displayName	string	No	The display name of the digital employee.	test
tags	array	No	The tags.
	Tag	No	The tag.
resourceGroupId	string	No	The ID of the resource group.	rg-ae******ey

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.