CreateAgentSpec

Updated at:
Copy as MD

Creates an AgentSpec in a specified workspace and generates the first draft version. Returns a resource conflict error if an AgentSpec with the same name already exists.

Operation description

Creates an agent template (AgentSpec) and generates the first draft version for editing reusable agent configurations. The creation fails if a template with the same name already exists in the same workspace. After creation, you can query the template and version information by calling GetAgentSpec.

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

agentcore:CreateAgentSpec

create

*AgentSpec

acs:agentcore:{#regionId}:{#accountId}:workspace/{#workspaceId}/agent-spec/{#agentSpecName}

None None

Request syntax

POST /workspaces/{workspaceId}/agent-specs HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspaceId

string

Yes

The workspace ID.

550e8400-e29b-41d4-a716-446655440000

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

agentSpecName

string

Yes

The unique name of the AgentSpec.

my-worker

targetVersion

string

No

Specifies the draft version number. If not specified, the default value is 0.0.1.

0.0.1

When you call the Create an AgentSpec operation, pass the following parameters as defined: workspace ID and request body.

Response elements

Element

Type

Description

Example

object

RestResult

requestId

string

The request ID.

A1B2C3D4-E5F6-47A8-90AB-CDEF12345678

data

string

The returned data.

agentspec-1234567890abcdef

The response of the Create an AgentSpec operation includes the following elements: request ID and returned data.

Examples

Success response

JSON format

{
  "requestId": "A1B2C3D4-E5F6-47A8-90AB-CDEF12345678",
  "data": "agentspec-1234567890abcdef"
}

Error codes

HTTP status code

Error code

Error message

Description

400 IllegalRequest Illegal request: %s. Illegal request
400 InvalidParameter Parameter error: %s. The parameter is invalid.
400 InvalidParameter.ImportFileSize The import file size exceeds the allowed limit: %s. The size of the imported file exceeds the limit.
500 InternalError An internal error occurred. Please try again later. Internal exception, please try again later; If it continues to fail, please provide RequestId troubleshootingAn internal service error occurred. Try again later. If the problem persists, provide the RequestId for troubleshooting.
403 NoPermission You are not authorized to perform this operation: %s. You do not have permission to perform this operation.
404 NotFound Not found: %s. The specified workspace, resource, or version does not exist
409 AgentSpecAlreadyExist Resource already exists: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.