CreateDigitalEmployee-STAROps(STAROps)-阿里云帮助中心

Create 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	Specifies the data structure for the digital employee.
defaultRule	string	No	The default rule for 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 RAM role ARN.	acs:ram::12345678912:role/testrole
name	string	Yes	The name of the digital employee.	test
knowledges	object	No	The knowledge bases to associate with the digital employee.
bailian	array<object>	No	The Bailian knowledge bases to associate with the digital employee.
	object	No	A Bailian knowledge base.
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 Bailian knowledge base.	cn-beijing
attributes	string	No	The attributes of the Bailian knowledge base.	test
sop	array<object>	No	The SOP knowledge bases to associate with the digital employee.
	object	No	An 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 ID of the resource group for the digital employee.	rg-ae******ey
tags	array	No	The tags to attach to the digital employee.
	Tag	No	A tag.
attributes	object	No
	string	No

Response elements

Element	Type	Description	Example
	object
requestId	string	A unique identifier for the request.	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.

上一篇: Digital employee 下一篇: GetDigitalEmployee