Defines a DocType in the caller's org: the metadata that gives a document…
Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether it has a submit/cancel lifecycle,…
POST /v1/framework/doctypes
| Address | https://api.hanzo.ai/v1/framework/doctypes |
| Method | POST |
| Operation | post_framework_doctypes |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether it has a submit/cancel lifecycle, and which role may do what to it. Manager-only — on a fresh org the first caller to administer it is seeded as its System Manager, after which only a System Manager (or a platform admin) may define. Answers 201.
Request
28 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
autoname | body | string | — | |
createdAt | body | integer | — | |
fields | body | DocField[] | — | |
fields[].default | body | string | — | |
fields[].fetchFrom | body | string | — | |
fields[].fieldname | body | string | — | |
fields[].fieldtype | body | string | — | |
fields[].hidden | body | boolean | — | |
fields[].inListView | body | boolean | — | |
fields[].label | body | string | — | |
fields[].options | body | string | — | |
fields[].readOnly | body | boolean | — | |
fields[].reqd | body | boolean | — | |
fields[].unique | body | boolean | — | |
isSingle | body | boolean | — | |
isSubmittable | body | boolean | — | |
module | body | string | — | |
name | body | string | — | |
permissions | body | DocPerm[] | — | |
permissions[].cancel | body | boolean | — | |
permissions[].create | body | boolean | — | |
permissions[].delete | body | boolean | — | |
permissions[].read | body | boolean | — | |
permissions[].role | body | string | — | |
permissions[].submit | body | boolean | — | |
permissions[].write | body | boolean | — | |
titleField | body | string | — | |
updatedAt | body | integer | — |
Response
| Status | Body | Meaning |
|---|---|---|
201 | DocType | created |
201 body — 28 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
autoname | body | string | — | |
createdAt | body | integer | — | |
fields | body | DocField[] | — | |
fields[].default | body | string | — | |
fields[].fetchFrom | body | string | — | |
fields[].fieldname | body | string | — | |
fields[].fieldtype | body | string | — | |
fields[].hidden | body | boolean | — | |
fields[].inListView | body | boolean | — | |
fields[].label | body | string | — | |
fields[].options | body | string | — | |
fields[].readOnly | body | boolean | — | |
fields[].reqd | body | boolean | — | |
fields[].unique | body | boolean | — | |
isSingle | body | boolean | — | |
isSubmittable | body | boolean | — | |
module | body | string | — | |
name | body | string | — | |
permissions | body | DocPerm[] | — | |
permissions[].cancel | body | boolean | — | |
permissions[].create | body | boolean | — | |
permissions[].delete | body | boolean | — | |
permissions[].read | body | boolean | — | |
permissions[].role | body | string | — | |
permissions[].submit | body | boolean | — | |
permissions[].write | body | boolean | — | |
titleField | body | string | — | |
updatedAt | body | integer | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo framework doctypes createimport { Configuration, FrameworkApi } from 'hanzoai';
const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postFrameworkDoctypes({ autoname: "<autoname>", createdAt: 0 });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_doctypes(autoname="<autoname>", created_at=0)cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.FrameworkAPI.PostFrameworkDoctypes(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_doctypes(&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).postFrameworkDoctypes();curl -X POST https://api.hanzo.ai/v1/framework/doctypes \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"autoname": "<autoname>",
"createdAt": 0
}'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?