vision

Create a scout that watches this scanner, recorded as belonging to it.

post/api/projects/{project_id}/vision/scanners/{scanner_id}/scouts/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/vision/scanners/{scanner_id}/scouts/
  • Auth: 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/.

scanner_idstring required

Request body

display_namestring

Name shown wherever people identify this scout, written however you want it — spaces, capitalization, and acronyms are kept as typed, and two scouts may share one. It does not change the scout's skill name, which stays its identity, so renaming a scout keeps its schedule, run history, notes, memory, and links. At most 200 characters; blank means the scout has no name of its own and is labelled from its skill name instead.

namestring

Optional skill name for the scout — its permanent identifier, containing only lowercase letters, numbers, and hyphens. Omit it and one is generated from display_name (My APM scout becomes my-apm-scout), with a numeric suffix when that name is taken. Pass it to pick the identifier yourself, or to keep a client written before display names working unchanged. The signals-scout- prefix is optional.

descriptionstring required

Short description of the signal or behavior this scout investigates.

bodystring required

Complete markdown prompt executed on every scout run. Include any project-specific signal names, thresholds, investigation steps, and report criteria here.

variant_analysisboolean

Make this the experiment scanner's variant analysis scout: its runs record a structured comparison of the variants, which the scanner's variants readout shows. Experiment scanners only.

Response

The scout already existed; the supplied config was applied.

createdboolean required

False when a scout of this name already existed and the supplied config was applied to it.

Changes

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