v3

OpenAPI 3.1.02026-08-06274467602.9 KB
query

Parse User Query

Parse a user query in real-time, returning structured layer identification.

This is a lightweight, stateless endpoint designed for debounced calls as the user types, powering the live preview chips on the Canvas empty state.

post/api/v1/query/parse

Request body

query_textstring required

The user's natural language query to parse

Response

Successful Response

warningsstring[]

Warnings for the user about the parsed geography.

multi_geography_errorstring nullable

Error when the query targets multiple separate geographies (only one is supported per project)