Retrieve Subgraph
Graph-aware retrieval — returns ranked node matches for a query, optionally with a surrounding subgraph.
Pass 1 (FTS today; hybrid when embeddings are enabled) finds entry-
point nodes. Pass 2 graph expansion is opt-in via expansion_depth:
the default "none" returns only the ranked matches; "shallow",
"standard", and "deep" progressively include children, parents,
and connection endpoints so agent callers get enough topology to
reason without N follow-up requests.
See docs/notes/features/rag/RETRIEVAL_API_PLAN.md.
Headers
Path Parameters
Body
Request body for POST /orgs/{org_id}/search/retrieve.
See docs/notes/features/rag/RETRIEVAL_API_PLAN.md for the full API design.
Natural-language query or keywords
Number of entry-point matches before graph expansion
1 <= x <= 50How aggressively Pass 2 walks the graph. 'none' (default) returns only the ranked matches with no graph expansion; 'shallow'/'standard'/'deep' progressively include children, parents, and connection endpoints.
none, shallow, standard, deep Optional scope filters
Return the prose text_content per node (for debugging / eval)