max
conversations

Create-or-resume a sandbox conversation — the single sandbox session opener. With content, processes the turn (first message, in-progress follow-up, or terminal resume); without content, warms a sandbox that idles awaiting the first message. Returns the (task, run) handle the frontend opens SSE against. The conversation row is created on first use from the URL id.

post/api/projects/{project_id}/conversations/{conversation}/open/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/conversations/{conversation}/open/
  • 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

contentstring nullable

The user's message text. Omit or null to warm a sandbox (boot + idle) ahead of the first message.

trace_idstring uuid

Client-generated trace id correlated with the resulting Run's SSE stream.

initial_permission_mode'default' | 'acceptEdits' | 'plan' | 'bypassPermissions' | 'auto'
  • default - default
  • acceptEdits - acceptEdits
  • plan - plan
  • bypassPermissions - bypassPermissions
  • auto - auto
task_idstring uuid

Bind a brand-new sandbox conversation to an existing Task so the first message resumes that Task's run. Honored only when this request creates the conversation row; ignored for an already-existing conversation.

Response

task_idstring required

The products/tasks Task backing the conversation.

run_idstring required

The Run the frontend opens SSE against.

trace_idstring nullable required

Echo of the request trace id, if provided.

run_statusstring required

Current status of the targeted Run (e.g. queued, in_progress).

just_created_runboolean required

True when a new Run was created (first message, terminal resume, or fresh warm); false for an in-progress follow-up or a reused warm Run.

Changes

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