OpenapiFramework
Reports how much of the DocType surface the caller's org uses: how many…
Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many documents exist across them.
GET /v1/framework/summary
| Address | https://api.hanzo.ai/v1/framework/summary |
| Method | GET |
| Operation | get_framework_summary |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many documents exist across them.
Request
GET /v1/framework/summary takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | summaryView | ok |
200 body — 2 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
doctypes | body | integer | — | DocTypes is how many DocTypes the org has defined. |
documents | body | integer | — | Documents is how many documents exist across them. |
Failure carries the platform error shape — see Errors.
Examples
hanzo framework summaryimport { Configuration, FrameworkApi } from 'hanzoai';
const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFrameworkSummary();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_summary()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.FrameworkAPI.GetFrameworkSummary(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_summary(&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).getFrameworkSummary();curl https://api.hanzo.ai/v1/framework/summary \
-H "Authorization: Bearer $HANZO_API_KEY"Tool framework, op get_framework_summary — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "framework",
"arguments": {
"op": "get_framework_summary",
"input": {}
}
}
}'How is this guide?