Skip to main content
POST
Get repository file tree

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token. Example: "Authorization: Bearer {apiKey}"

Body

output_format
null | enum<string>

Optional success projection. Omit to return both obj and rendered; use json for obj only; use agentic for rendered text only. Repairable errors always return both obj.error and rendered.

Available options:
json,
agentic
data_source
null | string

One repository name or id returned by get_data_sources. Required when more than one repository is visible.

path
null | string

Optional repository-relative directory path. Omit for repository root.

max_depth
null | integer<int32>

Optional traversal depth limit.

max_nodes
null | integer<int32>

Optional maximum number of tree nodes to return.

output_depth
null | integer<int32>

Optional rendered output depth limit.

Response

Success envelope. obj contains trees[] (one per resolved repository) with a rendered tree string and a hint; rendered is the JSON-serialized form of obj. Repairable failures (missing or invalid arguments, ambiguous or unknown data sources) also return HTTP 200 with obj.error = { code, message, retry, try } and a rendered <tool_error> block; repair the arguments and retry.

obj
any

Arbitrary JSON result for the tool. Present for omitted/json success projections and every repairable error.

rendered
null | string

Agent-facing result text. Present for omitted/agentic success projections and every repairable error.