vision

Rank observations by semantic similarity to the search text, optionally filtered by exact outcome (verdict, score, tags).

get/api/projects/{project_id}/vision/observations/search/

Request

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

Query parameters

date_fromstring

Only observations analyzed at or after this time. Accepts ISO 8601, a relative date like -7d, or now; values without an explicit offset are interpreted in the project's timezone.

date_tostring

Only observations analyzed at or before this time. Accepts ISO 8601, a relative date like -1d, or now for the current time; omit it to query through the current time. Date-only values include the whole day, interpreted in the project's timezone.

limitinteger

Maximum number of results (default 20, at most 50).

max_scorenumber double

Keep only scorer observations with a score at or below this value.

min_scorenumber double

Keep only scorer observations with a score at or above this value.

qstring required

Natural-language description of what to find, e.g. 'users confused by the pricing page'.

scanner_idstring uuid

Search a single scanner's observations. Defaults to every scanner you can read.

tagsstring

Comma-separated classifier tags to keep. Matching is case- and format-insensitive. Unlike verdict, tags are not validated against a fixed list, so an unknown tag matches nothing.

verdictstring

Comma-separated monitor verdicts to keep, e.g. yes,inconclusive.

Response

truncatedboolean required

True when more matches may exist beyond results, so the response is a top slice rather than everything that matched.

rerankedboolean required

True when a relevance model reordered the top results after the embedding match. False when the results are in embedding distance order, for example because the model did not answer in time.

Changes

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