query

Interpret a bounded property request without reading parcel rows.

Returns ready, clarify, or unsupported. Only ready includes an executable QueryRequest. Forward the returned state as previous_plan for corrections; all supplied state is revalidated and grants no authorization. Query and export retain their existing entitlement, scope, quota and row controls. ZIP filters require bounded county or state scope. Unsupported meanings never silently disappear. This endpoint is authenticated and rate limited.

post/v1/interpret

Request

  • Base URL: https://api.premiumpin.com
  • URL: https://api.premiumpin.com/v1/interpret
  • Auth: one of:
    • HTTP bearer
    • API key in cookie pp_session

Request body

limitinteger
previous_planobject

Explicit state from the previous interpretation.

selectstring[]
utterancestring required

Response

Interpretation only; no parcel query or export executed.

action'search' | 'lookup' | 'export' | 'count' | 'field_catalog' required
clarificationobject

Structured clarification for one unresolved span; never leftover-token residue.

planunknown
plan_hashstring
questionstring
reasonstring
stateobject required
status'ready' | 'clarify' | 'unsupported' required

Changes

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