task_channels

Start a test first-run onboarding session

Feature-flagged test path that creates a repeatable session from explicit prompt-building inputs, in the requester's personal space.

post/api/projects/{project_id}/task_channels/onboarding_session_test/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/task_channels/onboarding_session_test/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

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

modelstring nullable

Optional LLM model identifier for the test session. Omit to use the plan default.

company_domainstring

Company domain to research. Blank simulates a personal email address.

joining_existing_organizationboolean

Whether the user is joining an organization that already has shared context.

has_eventsboolean

Whether the project has ingested events.

signal_reports_waitinginteger

Number of findings waiting in #general.

other_membersstring[]

Display names of other Desktop users in the organization.

sources_enabledstring[]

Signal sources that were already enabled.

sources_watchingstring[]

Signal sources the onboarding flow is watching.

sources_newly_enabledboolean

Whether onboarding enabled any signal sources.

Response

task_idstring uuid required

The agent session opened in the team's #general space.

channel_idstring uuid required

The requester's personal space containing the session.

Changes

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