{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Knowledge Model API","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"knowledge-model-api","__idx":0},"children":["Knowledge Model API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This documentation describes how to interact with the Celonis Knowledge Model REST API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"goals","__idx":1},"children":["Goals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Knowledge Model API allows customers to embed actionable intelligence into third-party platforms where end-users may benefit from Celonis insights. In this manner, we would bring Celonis intelligence closer to our end-users and benefit operational users without current access to Celonis by providing valuable insights for better decision-making while executing their day-to-day activities."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The current API methods allow consumers to interact with Knowledge Models defined in the Celonis Platform by providing the following functionalities:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Discover"]}," Celonis knowledge structure (organized in a process context entity - Knowledge Model):",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Records"]}," (data structures, either auto-generated, i.e. tables, or curated i.e. views)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["KPIs"]}," (metrics measuring process efficiency and value)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Filters"]}," (business condition criteria)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Triggers"]}," (events indicating the occurrence of a business condition)"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query"]}," Celonis knowledge data:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["across all records of a knowledge model"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a specific record of a knowledge model"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":2},"children":["How it works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In order to understand Celonis Knowledge structure, you need to use the Knowledge Model API discovery end-points first."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Celonis knowledge is organized in Knowledge Models which represent a process context (use case) related to a specific process and can be browsed iteratively."," ","Refer to our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/process-intelligence-apis/knowledge-model-api/glossary"},"children":["glossary"]}," to understand the Celonis Knowledge concepts better."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n Knowledge_Model ||--|{ Filter: contains\n\t Knowledge_Model {\n \tstring id\n \tstring name\n \tdatetime published\n }\n\t Filter {\n \tstring id\n \tstring name\n \tstring description\n }\n Knowledge_Model ||--|{ KPI: contains\n\t KPI {\n \tstring id\n \tstring type\n \tstring format\n \tstring unit\n \tstring name\n \tstring direction\n \tstring target\n \tstring parameters\n }\n Knowledge_Model ||--|{ Record: contains\n\t Record {\n \tstring id\n \tstring name\n \tstring description\n \tstring shortDisplayName\n \tstring internalNote\n }\n Knowledge_Model ||--|{ Trigger: contains\n\t Trigger {\n \tstring id\n \tstring name\n \tstring record\n }\n Record||--|{ Field : contains\n\t Field {\n \tstring id\n \tstring type\n \tstring format\n \tstring unit\n \tstring name\n \tstring description\n \tstring shortDisplayName\n \tstring internalNote\n }\n Field ||..o{ KPI : \"uses\"\n","diagramHtml":"","diagramHtmlDark":""},"children":["erDiagram\n Knowledge_Model ||--|{ Filter: contains\n\t Knowledge_Model {\n \tstring id\n \tstring name\n \tdatetime published\n }\n\t Filter {\n \tstring id\n \tstring name\n \tstring description\n }\n Knowledge_Model ||--|{ KPI: contains\n\t KPI {\n \tstring id\n \tstring type\n \tstring format\n \tstring unit\n \tstring name\n \tstring direction\n \tstring target\n \tstring parameters\n }\n Knowledge_Model ||--|{ Record: contains\n\t Record {\n \tstring id\n \tstring name\n \tstring description\n \tstring shortDisplayName\n \tstring internalNote\n }\n Knowledge_Model ||--|{ Trigger: contains\n\t Trigger {\n \tstring id\n \tstring name\n \tstring record\n }\n Record||--|{ Field : contains\n\t Field {\n \tstring id\n \tstring type\n \tstring format\n \tstring unit\n \tstring name\n \tstring description\n \tstring shortDisplayName\n \tstring internalNote\n }\n Field ||..o{ KPI : \"uses\"\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can then query Celonis knowledge and retrieve data either from a specific record or from any records and KPIs of the Knowledge Model."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To query at the KM record level, the consumer selects:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," to be included in the results (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," can be raw or calculated ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["attributes"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["augmented attributes"]}," or ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["flags"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the predefined ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," to be applied"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the sorting field (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["ad-hoc filters to be applied (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," of the results and the current ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," index"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To query at the KM level, the consumer selects:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["record.fields"]}," to be included in the results"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kpis"]}," to be included in the results"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the predefined ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," to be applied"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the sorting field (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["ad-hoc filters to be applied (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterExpr"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," of the results and the current ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," index"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"further-considerations","__idx":3},"children":["Further Considerations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In order to have access to a specific Knowledge Model and its contents, the Knowledge Model must be published in the Celonis Platform."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The returned data corresponds to the last ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["published"]}," version of the Knowledge Model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"feedback","__idx":4},"children":["Feedback"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We value your feedback and are constantly striving to improve our APIs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have encountered any problems or have any suggestions for new features, please take a moment to share your"," ","thoughts with us through"," ","this ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.google.com/forms/d/e/1FAIpQLSeHANiDNRaHNCbdgH0hc1kQv35V2yHb5gkDpZTYjoT-6Gd-rQ/viewform?usp=sf_link"},"children":["form"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your input is important to us and will help us make our APIs even better."]}]},"headings":[{"value":"Knowledge Model API","id":"knowledge-model-api","depth":1},{"value":"Goals","id":"goals","depth":2},{"value":"How it works","id":"how-it-works","depth":2},{"value":"Further Considerations","id":"further-considerations","depth":2},{"value":"Feedback","id":"feedback","depth":2}],"frontmatter":{"seo":{"title":"Knowledge Model API"}},"lastModified":"2026-03-03T20:42:57.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/process-intelligence-apis/knowledge-model-api/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}