ChatMessages-阿里云帮助中心

Sends chat messages.

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

rdsai:ChatMessages

none

*All Resource

*

None

Request syntax

POST /v1/chat-messages HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Query	string	Yes	The content of the query.	实例rm-bp14as9914vd3**** 磁盘使用率，是否需要进行扩容
ConversationId	string	No	The ID of the conversation.	fea7bdca-e848-44dd-b1ae-852472b8****
ParentMessageId	string	No	The ID of the parent message.	84dc9f9b-424a-404d-9c36-35e9d000****
Inputs	object	No	The inputs for the task.
CustomAgentId	string	No	The custom agent ID.	d1b7d639-f34e-44c7-8231-987da14d****
RegionId	string	No	The ID of the region.	cn-beijing
Timezone	string	No	The time zone. Default value: Asia/Shanghai.	UTC
Language	string	No	The language of the conversation.	zh-cn
EventMode	string	No

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	FE9C65D7-930F-57A5-A207-8C396329****
Answer	string	The content of the generated answer.	您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%，暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作，请告诉我你的具体需求！
ConversationId	string	The ID of the conversation.	9cbbe885-b240-4803-9d15-6781a3fd****
CreatedAt	integer	The time when the message was created. This value is a UNIX timestamp.	1763986004
MessageId	string	The unique ID of the message.	oas8pwy2-slxw-sf98-bx83-cb2hkktl****
Mode	string	The query mode.	以后会下线，不用关注。
Event	string	The event associated with the message.	MysqlIOException
Id	string	The ID of the message, which is distinct from `MessageId`.	60b335ca-124d-4ee1-864b-de554987****
TaskId	string	The ID of the asynchronous task.	01c3d43d-9466-4bd5-8196-4cbbce08****

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Answer": "您询问的实例rm-bp14as9914vd3**** 磁盘使用率为23%，暂时不需要进行扩容。如果您需要进一步查看某个实例的详细配置、性能监控或进行其他操作，请告诉我你的具体需求！",
  "ConversationId": "9cbbe885-b240-4803-9d15-6781a3fd****",
  "CreatedAt": 1763986004,
  "MessageId": "oas8pwy2-slxw-sf98-bx83-cb2hkktl****",
  "Mode": "以后会下线，不用关注。",
  "Event": "MysqlIOException",
  "Id": "60b335ca-124d-4ee1-864b-de554987****",
  "TaskId": "01c3d43d-9466-4bd5-8196-4cbbce08****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.
400	InvalidOrder	No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.	No valid order found, please check whether RDS Copilot Professional Edition has been activated and ensure that the order is valid.
404	UserNotFound	User does not exist.	User does not exist.
429	TooManyRequests	The current maximum concurrent requests have exceeded the threshold.	The current maximum number of concurrent requests has exceeded the threshold. Purchase a AI package to increase the concurrency limit or reduce the current number of concurrent requests.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.