Cancel Conversation

conversations.cancel(, ) -> ConversationCancelResponse

post/v1/conversations/{conversation_id}/cancel

Cancel runs associated with a conversation.

Note: To cancel active runs, Redis is required.

Agent-direct mode: Pass conversation_id="default" with agent_id query parameter to cancel runs for the agent's default conversation.

Deprecated: Passing an agent ID as conversation_id still works but will be removed.

ParametersExpand Collapse

conversation_id: str

The conversation identifier. Can be a conversation ID ('conv-'), 'default' for agent-direct mode (with agent_id parameter), or an agent ID ('agent-') for backwards compatibility (deprecated).

minLength1

maxLength42

agent_id: Optional[str]

Agent ID for agent-direct mode with 'default' conversation

ReturnsExpand Collapse

Dict[str, object]

Cancel Conversation

import os
from letta_client import Letta

client = Letta(
    api_key=os.environ.get("LETTA_API_KEY"),  # This is the default and can be omitted
)
response = client.conversations.cancel(
    conversation_id="default",
)
print(response)

{
  "foo": "bar"
}

Returns Examples

{
  "foo": "bar"
}