DeleteCopilotSession

Updated at:

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

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

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.

  • If code is Success, the authorization is successful.

  • Other status codes indicate that the authorization failed. If the authorization fails, check the message field for the detailed fault message.

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.