Vision

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

POST
← Previous page

Create vision scanners suggest tags

Suggest classifier tags grounded in the scanner's own observations and the org's product data.

Required API key scopes

replay_scanner:readsession_recording:read

Request parameters

  • prompt
    string
  • tags
    array
  • multi_label
    boolean
    Default: true
  • allow_freeform_tags
    boolean
    Default: false
  • scanner_id
    stringnull

Response


Example request

POST /api/projects/:project_id/vision/scanners/suggest_tags
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/suggest_tags/\
	-d prompt="string"

Example response

Status 200
RESPONSE
{
  "suggestions": [
    {
      "tag": "string",
      "rationale": "string",
      "source": "observed"
    }
  ]
}
← Previous page

Community questions