Get modules

Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them already exist in the org.

GET /v1/framework/modules/{module}

Framework → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/framework/modules/{module}`
Method	`GET`
Operation	`get_framework_modules_by_module`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them already exist in the org. That is the honest "set up" versus "installed" answer a console renders.

Request

1 field.

Field	In	Type	Required	Description
`module`	path	string	yes	Module is the lane's registered name ("cms", "erp"), from the path.

Response

Status	Body	Meaning
`200`	framework.ModuleState	ok
`default`	problem-details	refused

200 body — 3 fields.

Field	In	Type	Always
`doctypes`	body	string[]	—
`installed`	body	string[]	—
`module`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo framework modules get <module>

.ts

.py

.go

.rs

.java

import { Configuration, FrameworkApi } from 'hanzoai';

const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFrameworkModulesByModule({ module: 'module' });

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_by_module(module='module')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FrameworkAPI.GetFrameworkModulesByModule(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::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_by_module(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FrameworkApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FrameworkApi(client).getFrameworkModulesByModule();

curl https://api.hanzo.ai/v1/framework/modules/<module> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches framework through the framework tool, which names its 14 operations with its own verbs — this one among them, under a name only MCP 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"
         }
       }
     }'

Framework API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList doctypes NextList modules