OpenapiFramework
Creates an app lane's DocTypes in the caller's org.
Creates an app lane's DocTypes in the caller's org.
POST /v1/framework/modules/{module}/install
| Address | https://api.hanzo.ai/v1/framework/modules/{module}/install |
| Method | POST |
| Operation | post_framework_modules_by_module_install |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Creates an app lane's DocTypes in the caller's org. Idempotent and create-if-absent: a DocType the org already has is reported as existing and never replaced, so re-installing cannot clobber a definition the org has since edited. Manager-only.
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 | Install | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
created | body | string[] | — | |
existing | body | string[] | — | |
module | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo framework modules install <module>import { Configuration, FrameworkApi } from 'hanzoai';
const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postFrameworkModulesByModuleInstall({ 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).post_framework_modules_by_module_install(module='module')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.FrameworkAPI.PostFrameworkModulesByModuleInstall(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::post_framework_modules_by_module_install(&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).postFrameworkModulesByModuleInstall();curl -X POST https://api.hanzo.ai/v1/framework/modules/<module>/install \
-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?