Skip to main content
DELETE
Stop an agent session

Authorizations

Authorization
string
header
required

Authentication requires a Pipecat Cloud Private API token.

Generate a Private API key from your Dashboard (Settings > API Keys > Private > Create key) and include it as a Bearer token in the Authorization header.

Path Parameters

agentName
string
required

Name of the agent

sessionId
string<uuid>
required

UUID of the session to stop

Response

Session stopped successfully

status
string

Status of the stop operation

Example:

"terminated"

session_id
string<uuid>

Session ID of the stopped session

Example:

"639f91d8-d511-4677-a83b-bd7564d5d92f"