HelixDB

Execute Query

Execute dynamic HelixQL.

Optional scope ("<kind>:<value>") stamps any writes the query performs (X-Scope-Id); mutating queries can't be distinguished here, so it is a pass-through — the engine's own write gate (D-2) is authoritative. Must be within the caller's visible scopes (403 otherwise).

post/helixdb/query

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/helixdb/query/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

querystring required

HelixQL query string

paramsobject

Query parameters

scopestring nullable

Optional explicit write scope "<kind>:<value>" (kinds: user/team/org/project). Must be within the caller's visible scopes; defaults to user:<user_id>.

Response

Successful Response

successboolean required

Whether query succeeded

dataunknown

errorstring nullable

Error message if failed

Changes

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

Execute Query

Request

Request body

Response 200OK

Changes

Response