DeleteCopilotSession - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

You can delete only the sessions of the current user.
You cannot delete a session if it has an ongoing execution. Send action=stop by calling the GenerateCopilotStreamResponse operation first, and delete the session after you confirm that the execution has ended.
After the session is deleted, you can no longer retrieve the session or its history by calling the session query operation.
An error is returned if the session does not exist or does not belong to the current user. Repeatedly deleting the same session is not guaranteed to succeed.
Deleting a session does not roll back executed operations or delete the scheduled task that created the session.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

DELETE /api/v1/copilot/delete-session HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
sessionId	string	Yes	The session ID.	c356bc310e4345c3a602a2912322ad21
agentId	string	No	The agent identifier.	sre_agent

Response elements

Element	Type	Description	Example
	object
code	string	The status code. If `code` is `Success`, the authorization is successful. Other status codes indicate that the authorization failed. If the authorization failed, check the `message` field for the detailed fault message.	Success
data	object	The response data.
deleted	boolean	Indicates whether the deletion was successful.	true
sessionId	string	The ID of the deleted session.	c356bc310e4345c3a602a2912322ad21
message	string	The error message returned when `code` is not `Success`.	""
requestId	string	The request ID, which can be used for end-to-end diagnostics.	5BC79EF5-798B-5499-9683-4E14EBBBF712

Examples

Success response

JSON format

{
  "code": "Success",
  "data": {
    "deleted": true,
    "sessionId": "c356bc310e4345c3a602a2912322ad21"
  },
  "message": "\"\"",
  "requestId": "5BC79EF5-798B-5499-9683-4E14EBBBF712"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.