InvokeAIAgent-阿里云帮助中心

Invokes an AI agent.

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

apig:InvokeAIAgent

none

*All Resource

*

None

Request syntax

POST /v1/ai-agents/invoke HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
agentName	string	Yes	The agent name. Valid values: pluginCodeCompletion : plugin code completion. pluginCodeGen : plugin code generation. slsLogDiagnose : SLS log intelligent diagnostics (AI diagnostic conversation) apiDesign : API design (AI generation in the API import wizard) bodySchemaGenerate : request/response body schema generation. mcpYamlGen : MCP Server YAML generation. mockDataGenerate : mock data generation.	slsLogDiagnose
prompt	string	No	The user input for the current turn. If left empty, a default prompt is used based on the scenario, such as "Start".	Help me diagnose this error log
outputLanguage	string	No	The output language. When set to en, fallback error messages are returned in English.	zh / en
bizParams	object	No	The business parameters. Each agent performs custom validation on these parameters, such as passing the SLS context for log diagnostics.
	string	No	The business parameters. Each agent performs custom validation on these parameters, such as passing the SLS context for log diagnostics.	{"project":"xxx","logStore":"xxx"}
history	array<object>	No	The conversation history. Each element contains role (user/assistant) and content. The role and content fields in each element cannot be empty.
	object	No	The conversation history. Each element contains role (user/assistant) and content. The role and content fields in each element cannot be empty.
role	string	No	The role.	user
content	string	No	The content of the message. The returned data is in rich text format.	Previous question

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	Id of the request	A60EE5CA-1294-532A-9775-8D2FD1C6EFBF
code	string	The response status code.	200
message	string	The response message.	success
data	object	The response data.
httpCode	integer	The HTTP status code of the debug result.	200
headers	object	The response headers, such as Content-Type: text/event-stream.
	string	The response headers, such as Content-Type: text/event-stream.	{"Content-Type":"text/event-stream"}
body	string	The response body of the debug result.	{"choices":[{"delta":{"content":"Analysis result..."}}]}

Examples

Success response

JSON format

{
  "requestId": "A60EE5CA-1294-532A-9775-8D2FD1C6EFBF",
  "code": "200",
  "message": "success",
  "data": {
    "httpCode": 200,
    "headers": {
      "key": "{\"Content-Type\":\"text/event-stream\"}"
    },
    "body": "{\"choices\":[{\"delta\":{\"content\":\"分析结果...\"}}]}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.