signals

Start a scout chat task

Create and run a cloud task for one of the fixed scout chat templates (suggest a scout, fleet overview, recent signals). The prompt is server-owned; an author_scout chat can carry the user's request, which the server fences inside that prompt. The response carries the task id to navigate to.

post/api/projects/{project_id}/signals/scout/chat_tasks/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/signals/scout/chat_tasks/
  • 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

chat_type'author_scout' | 'fleet_overview' | 'recent_signals' required
  • author_scout - author_scout
  • fleet_overview - fleet_overview
  • recent_signals - recent_signals
suggestion_idstring

Optional id of a suggestion from this project's scout suggestion batch. The chat then opens on that draft instead of scanning from scratch. author_scout only.

user_promptstring

Optional description, in the user's own words, of what the new scout should watch. The chat then opens on this request instead of asking from scratch. author_scout only, and not together with suggestion_id.

Response

Chat task created and run started

task_idstring uuid required

The created chat task. Open it on the task detail page to continue.

Changes

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