Parse a natural-language filter query
Extracts structured filter parameters from a natural-language query via the LLM backend. The keys of the returned data object depend on page_id.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Parse a natural-language filter query › Request Body
page_idPage the filters apply to (e.g. customers, invoices)
queryNatural-language filter query (max 500 chars)
Parse a natural-language filter query › Responses
OK