Ask examples
← All examples 6 natural-language examples, each on its own page. The Ask endpoint takes plain English in the "nl" field, compiles it into a Plan tree against your registered schemas, and returns rows plus a cache flag.
6 work today. Every example shows the request body the engine actually accepts, the JSON it returns, and the common ways a question can go wrong.
The minimum Ask call. Send a plain-English question, get rows and a cache flag back.
Pass the schemas list when you know which table the question is about. Faster, more predictable plans.
Set show_plan: true in the body to see the executor plan. Verify the index path before you put a question in a hot loop.
The compiler walks the relations between schemas and produces a JOIN underneath. Be specific about which column you mean.
Same question twice. The second call lands on cache: "hit" because the canonicalised question + schemas key already has a plan.
Gibberish in, structured error out. 400 with a no_plan_compiled body, a hint, and a suggested rephrase.