Version 2.0

Delete Session

DELETE/api/v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Delete a conversation session between the calling user and an Agent. Once deleted, the session can no longer be accessed and will not appear in session lists.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-write.

Path parameters

agentRid

string

An RID identifying an AIP Agent created in AIP Agent Studio.

sessionRid

string

The Resource Identifier (RID) of the conversation session.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Examples

Request

Copied!

curl -X DELETE \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions/ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6?preview=true"

Error responses

Error Name
`DeleteSessionPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not delete the Session.
	Parameters	`agentRid, sessionRid`
`SessionNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Session could not be found.
	Parameters	`agentRid, sessionRid`
`AgentNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Agent could not be found.
	Parameters	`agentRid`

See Errors for a general overview of errors in the platform.