Before You Begin
You will need:- Your organization ID
- A Humm API token
- The Config API base URL, usually
https://config.heyhumm.ai/api
Ontology updates create a new version. Fetch the current ontology first, make your edits locally, and include a short
change_log when you save.Recommended Flow
- Fetch the current ontology
- Save the JSON or YAML locally
- Draft your changes
- Review the diff
- Apply the
PUT - Verify the new version
1. Fetch the Current Ontology
JSON:2. Apply the Update
You can send eitherontology JSON or yaml. YAML is often easier to diff and review.
Python Example
TypeScript Example
Prompt Your Assistant
Verification
After saving, verify both the current ontology and version history:- The returned ontology matches the approved changes
- The version number increased
- The version history includes your
change_log
Notes
- YAML is easier to review when you want a human in the loop.
- JSON is a better fit if you generate ontology updates programmatically.
- Do not append duplicate top-level YAML keys like
business_glossaryto the end of the document. Parse and update the existing structure instead, or send the merged JSON ontology payload. - Keep changes narrow and intentional. Large ontology rewrites are harder to review and debug.