max
conversations

Cancel the conversation's in-progress LangGraph run.

patch/api/projects/{project_id}/conversations/{conversation}/cancel/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/conversations/{conversation}/cancel/
  • Auth: none declared

Path parameters

conversationstring uuid required

A UUID string identifying this conversation.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid
status'idle' | 'in_progress' | 'canceling'
  • idle - Idle
  • in_progress - In progress
  • canceling - Canceling
titlestring nullable

Title of the conversation.

created_atstring date-time nullable
updated_atstring date-time nullable
type'assistant' | 'tool_call' | 'deep_research' | 'slack'
  • assistant - Assistant
  • tool_call - Tool call
  • deep_research - Deep research
  • slack - Slack
is_internalboolean nullable

Whether this conversation was created during an impersonated session (e.g., by support agents). Internal conversations are hidden from customers.

slack_thread_keystring nullable

Unique key for Slack thread: '{workspace_id}:{channel}:{thread_ts}'

slack_workspace_domainstring nullable

Slack workspace subdomain (e.g. 'posthog' for posthog.slack.com)

messagesobject[]
has_unsupported_contentboolean
agent_modestring nullable
agent_runtime'langgraph' | 'sandbox'
  • langgraph - LangGraph
  • sandbox - Sandbox
is_sandboxboolean
pending_approvalsobject[]

Return pending approval cards as structured data.

Combines metadata from conversation.approval_decisions with payload from checkpoint interrupts (single source of truth for payload data).

Response

Cancellation accepted, or already cancelling.

Changes

No recorded changes to this operation across all 1 revision of this API.