HelixQL Planner

Generate Query Plan

post/planner/plan

Request

Base URL
https://api.getmetacognition.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/metacognition/apis/tex-api/docs/planner/plan/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

querystring required

Natural language query

enable_pruningboolean

Enable schema pruning

use_local_intelligenceboolean

Use local intelligent planner

Response

Successful Response

query_planobject required

Generated QueryPlan JSON

query_typestring required

Query type

constraint_embeddingsobject nullable

Optional map of variable name -> 1024-d embedding for that variable's constraint string (BAAI/bge-large-en-v1.5 via emprocesser). If present, IntegrationBackend will forward this to HelixDB /intent/matches to enable vector-first constraint resolution.

complexity_hintsobject nullable

Optional complexity hints from the planner (pass-through)

latency_msnumber required

Processing latency

helix_qlstring nullable

Generated HelixQL code

entityobject nullable

Detected entity info

planner_versionstring nullable

Planner version used

Changes

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

Generate Query Plan

Request

Request body

Response 200OK

Changes

Response