Hanzo Framework API

Metadata-driven DocType engine — the /v1/framework/* surface served by the

Hanzo Framework API · All API references →

Authentication

All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.

curl -H "Authorization: Bearer $HANZO_API_KEY" https://api.hanzo.ai

Method	Endpoint	Description
`GET`	`/v1/framework/summary`	Org summary (doctype + document counts)
`GET`	`/v1/framework/doctypes`	List DocType definitions
`POST`	`/v1/framework/doctypes`	Define a DocType
`GET`	`/v1/framework/doctypes/{name}`	Get a DocType definition
`PUT`	`/v1/framework/doctypes/{name}`	Replace a DocType definition
`DELETE`	`/v1/framework/doctypes/{name}`	Delete a DocType (and its documents)

Method	Endpoint	Description
`GET`	`/v1/framework/{doctype}`	List documents of a DocType
`POST`	`/v1/framework/{doctype}`	Create a document
`GET`	`/v1/framework/{doctype}/{name}`	Get a document
`PUT`	`/v1/framework/{doctype}/{name}`	Update a draft document
`DELETE`	`/v1/framework/{doctype}/{name}`	Delete a document
`POST`	`/v1/framework/{doctype}/{name}/submit`	Submit a document (docstatus 0→1)
`POST`	`/v1/framework/{doctype}/{name}/cancel`	Cancel a submitted document (docstatus 1→2)

Method	Endpoint	Description
`GET`	`/v1/framework/modules`	List registered app-lane modules
`GET`	`/v1/framework/modules/{module}`	Inspect a module and its install state in this org
`POST`	`/v1/framework/modules/{module}/install`	Install a module's DocType fixtures into this org (idempotent)

Method	Endpoint	Description
`GET`	`/v1/framework/roles`	List per-org role assignments
`POST`	`/v1/framework/roles`	Assign a role to a user
`DELETE`	`/v1/framework/roles/{user}/{role}`	Revoke a role from a user