CreateDigitalEmployee - STAROps - Alibaba Cloud Documentation Center

Creates a digital employee.

Operation description

Creates a digital employee.

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:CreateDigitalEmployee

create

*DigitalEmployee

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

None

ram:PassRole

Request syntax

POST /digital-employee HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The digital employee structure.
defaultRule	string	No	The default rule of the digital employee.	test
description	string	No	The description of the digital employee.	aaa
displayName	string	No	The display name of the digital employee.	digial-employee-test
roleArn	string	Yes	The ARN of the RAM role.	acs:ram::12345678912:role/testrole
name	string	Yes	The name of the digital employee.	test
knowledges	object	No	The list of knowledge bases.
bailian	array<object>	No	The list of Bailian knowledge bases.
	object	No	The list of Bailian knowledge bases.
workspaceId	string	No	The Bailian workspace ID.	llm-xxxxx
indexId	string	No	The Bailian index ID.	index-xxxx
region	string	No	The region of the knowledge base.	cn-beijing
attributes	string	No	The attributes of the knowledge base.	test
sop	array<object>	No	The list of SOP knowledge bases.
	object	No	The SOP knowledge base.	{ "type": "oss", "basePath": "docs/", "region": "cn-hangzhou", "endpoint": "oss-cn-hangzhou.aliyuncs.com", "bucket": "my-sop-bucket", "description": "sls sop" }
resourceGroupId	string	No	The resource group ID.	rg-ae******ey
tags	array	No	The tags.
	Tag	No	The tags.
attributes	object	No
	string	No
toolPolicy	object	No	The tool calling security policy configuration of the digital employee.	{"aliyun":{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}}
aliyun	object	No	The Aliyun MCP tool calling security policy configuration.	{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}
enable	boolean	No	Specifies whether to enable the Aliyun MCP tool policy.	true
statements	array<object>	No	The list of Aliyun OpenAPI tool policy statements.	[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]
	object	No	A single Aliyun OpenAPI tool policy statement.	{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}
decision	string	No	The execution policy when the API is matched.	user_ack
product	string	No	The Aliyun OpenAPI product name that this statement applies to.	Sls
apiVersion `deprecated`	string	No	The Aliyun OpenAPI version that this statement applies to.	2020-12-30
actions	array	No	The list of Aliyun OpenAPI actions. The format is product:ApiName, product:Prefix, or product:.	["log:GetProject","log:CreateDashboard"]
	string	No		log:GetProject
sandboxNetworkPolicy	object	No	The sandbox network ACL policy configuration of the digital employee.	{"allowFqdns":["api.example.com"],"allowCidrs":["1.2.3.0/24","8.8.8.8"],"enableAcl":false}
allowFqdns	array	No	The list of allowed FQDNs. A maximum of 50 FQDNs are supported.
	string	No
allowCidrs	array	No	The list of allowed CIDRs or IP addresses. A maximum of 50 entries are supported.
	string	No
enableAcl	boolean	No	Specifies whether to enable the sandbox network ACL.	false

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	3B311FD9-A60B-55E0-A896-A0C73*********
name	string	The name of the digital employee.	test

Examples

Success response

JSON format

{
  "requestId": "3B311FD9-A60B-55E0-A896-A0C73*********\n",
  "name": "test"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.