{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Try it!","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":"try-it","__idx":0},"children":["Try it!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If after reading the documentation you want to give the Knowledge Model API a try, we have prepared a"," ","demo environment that anyone can access. Authentication is required, but any token"," ","that you pass should work, so no need to get a User or Application key in advance."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To show how this environment works, we will use Postman, but you can use any other REST client."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The URL where this API can be located is: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api"]},". Keep in mind that"," ","for real production environments, the URL typically ends with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/intelligence/api"]}," and not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-create-a-new-http-request","__idx":1},"children":["1. Create a new HTTP Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's start this Tutorial by creating a new HTTP Request in Postman (File > New > HTTP Request). Make sure that you have"," ","selected a GET operation and paste the URL for the API next to it: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step1.a2d6032743d2d7ddaa4c957eac4d54246350eac78464761b5a776d164e8eca88.3c53a942.png","alt":"Create a new HTTP Request"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-configure-authentication","__idx":2},"children":["2. Configure authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's say we have our User API Key which is"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NASDYUmYxMjItNmJJHuNYSdn7FkLThhasdhj89jM2ODVmOio090sadjkdkVnRFV3VVBtZ1jksadb8olJWXMSDHUASDik3UE5j"]},". Go to Postman"," ","and use this key for the Authentication header."," ","Click on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," and select ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer Token"]}," for the Type. For the token, paste the above key."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step2.639caa743ba3d49f625a341eb4629a616b7d47b4c13c2e51e3bdb54dc60b019d.3c53a942.png","alt":"Configure authentication"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-get-the-list-of-knowledge-models","__idx":3},"children":["3. Get the list of Knowledge Models"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now we should be ready to start getting some information such as the full list of Knowledge Models. For that,"," ","you need to add '/knowledge-models' at the end of the URL. As we can see, there is one Knowledge Model with the id"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["open-purchase-requisition.purchase-requisition-km"]}," and named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Purchase Requisition KM"]},". As we can tell by the name, this"," ","Knowledge Model is giving us information about purchases that happened in the company."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step3.76f688efe99b5c49be4b6f5065bea41e71f8e5b72d64d52180a5b4332acbcce5.3c53a942.png","alt":"Get list of Knowledge Models"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-getting-details-for-a-specific-knowledge-model","__idx":4},"children":["4. Getting details for a specific Knowledge Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Next, let's see the details for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Purchase Requisition KM"]}," Knowledge Model. In order to do that, we need to append the"," ","id of the Knowledge Model to the URL we used for the previous step. In the results we can get extra information for this"," ","Knowledge Model, for example that is extending another Knowledge Model with id ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["open-purchase-requisition.purchase-requisition-km-base"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step4.f6a650bcaf08a15cb580ab1a8be0e1eca4092b70832251584eb59ab930c9a393.3c53a942.png","alt":"Getting details for a specific Knowledge Model"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-get-kpis-for-a-knowledge-model","__idx":5},"children":["5. Get KPIs for a Knowledge Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Imagine you want to retrieve all the KPIs within a Knowledge Model. This is possible just adding the Knowledge Model id,"," ","for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["open-purchase-requisition.purchase-requisition-km-base"]}," and later appending ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/kpis"]}," to the URL."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step17.77efae7d190e918202ad665818e0743831384086b56b8c831836282eda53ec0e.3c53a942.png","alt":"Get the triggers for a knowledge model"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-get-data-across-any-records--kpis-of-a-knowledge-model","__idx":6},"children":["6. Get data across any records & KPIs of a Knowledge Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finally, it's time to consume the data from different records and KPIs of the Knowledge Model. For this we need to first append ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/data"]}," to the URL we got"," ","in step #4. Then, we should also specify the field Ids and the KPI Ids that we want to retrieve. For this last step, add a parameter"," ","in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Params"]}," tab named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," with the value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MATERIALS.ACTIVITY"]}," and one with name ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kpis"]}," and the value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AVG_EVENTS_PER_CASE,FILTERED_COUNT"]},". The result:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step18.fcd9b62c582ec5d01af39cfda1584d9889f462981f863a1fdbd07b36a98513b3.3c53a942.png","alt":"Get the data for the Materials record"},"children":[]}]}]},"headings":[{"value":"Try it!","id":"try-it","depth":1},{"value":"1. Create a new HTTP Request","id":"1-create-a-new-http-request","depth":2},{"value":"2. Configure authentication","id":"2-configure-authentication","depth":2},{"value":"3. Get the list of Knowledge Models","id":"3-get-the-list-of-knowledge-models","depth":2},{"value":"4. Getting details for a specific Knowledge Model","id":"4-getting-details-for-a-specific-knowledge-model","depth":2},{"value":"5. Get KPIs for a Knowledge Model","id":"5-get-kpis-for-a-knowledge-model","depth":2},{"value":"6. Get data across any records & KPIs of a Knowledge Model","id":"6-get-data-across-any-records--kpis-of-a-knowledge-model","depth":2}],"frontmatter":{"seo":{"title":"Try it!"}},"lastModified":"2026-03-06T16:57:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/process-intelligence-apis/knowledge-model-api/api-reference/try-it","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}