DeleteCopilotSession
Deletes a specified Copilot session.
Operation description
You can delete only the sessions of the current user.
You cannot delete a session that has an ongoing execution. Call the GenerateCopilotStreamResponse operation and send action=stop to stop the execution before you delete the session.
After a 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. Success is not guaranteed if you repeatedly delete the same session.
Deleting a session does not roll back executed operations or delete the scheduled task that created the session.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
sysom:DeleteCopilotSession |
delete |
*All Resource
|
None | None |
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 |
|||
| requestId |
string |
The request ID, which can be used for end-to-end diagnostics. |
5BC79EF5-798B-5499-9683-4E14EBBBF712 |
| message |
string |
The error message returned when the code is not Success. |
"" |
| data |
object |
The returned data. |
|
| deleted |
boolean |
Indicates whether the session was deleted. |
true |
| sessionId |
string |
The ID of the deleted session. |
c356bc310e4345c3a602a2912322ad21 |
| code |
string |
The status code.
|
Success |
Examples
Success response
JSON format
{
"requestId": "5BC79EF5-798B-5499-9683-4E14EBBBF712",
"message": "\"\"",
"data": {
"deleted": true,
"sessionId": "c356bc310e4345c3a602a2912322ad21"
},
"code": "Success"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.