OpenapiFramework
Returns every app lane compiled into this deployment and the DocTypes each one…
Returns every app lane compiled into this deployment and the DocTypes each one installs.
GET /v1/framework/modules
| Address | https://api.hanzo.ai/v1/framework/modules |
| Method | GET |
| Operation | get_framework_modules |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns every app lane compiled into this deployment and the DocTypes each one installs. It describes the BINARY, not the org: what a given org has actually installed is the per-module state below.
Request
GET /v1/framework/modules takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | moduleList | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | ModuleInfo[] | — | Data is every module compiled into this binary, with the DocTypes it installs. |
data[].doctypes | body | string[] | — | |
data[].module | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo framework modules listimport { Configuration, FrameworkApi } from 'hanzoai';
const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFrameworkModules();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FrameworkApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FrameworkApi(client).get_framework_modules()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.FrameworkAPI.GetFrameworkModules(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, framework_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = framework_api::get_framework_modules(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FrameworkApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new FrameworkApi(client).getFrameworkModules();curl https://api.hanzo.ai/v1/framework/modules \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches framework through the framework tool, which names its 17 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_framework_by_doctype"
}
}
}'How is this guide?