{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/process-intelligence-apis/knowledge-model-api/api-reference/try-it/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Try it!

\n

If after reading the documentation you want to give the Knowledge Model API a try, we have prepared a\ndemo environment that anyone can access. Authentication is required, but any token\nthat you pass should work, so no need to get a User or Application key in advance.

\n

To show how this environment works, we will use Postman, but you can use any other REST client.

\n

The URL where this API can be located is: https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api. Keep in mind that\nfor real production environments, the URL typically ends with /intelligence/api and not /api.

\n

1. Create a new HTTP Request

\n

Let's start this Tutorial by creating a new HTTP Request in Postman (File > New > HTTP Request). Make sure that you have\nselected a GET operation and paste the URL for the API next to it: https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api.

\n

\n NASDYUmYxMjItNmJJHuNYSdn7FkLThhasdhj89jM2ODVmOio090sadjkdkVnRFV3VVBtZ1jksadb8olJWXMSDHUASDik3UE5j. Go to Postman\nand use this key for the Authentication header.\nClick on Authorization and select Bearer Token for the Type. For the token, paste the above key.

\n

\n \n \n

\n

3. Get the list of Knowledge Models

\n

Now we should be ready to start getting some information such as the full list of Knowledge Models. For that,\nyou need to add '/knowledge-models' at the end of the URL. As we can see, there is one Knowledge Model with the id\nopen-purchase-requisition.purchase-requisition-km and named Purchase Requisition KM. As we can tell by the name, this\nKnowledge Model is giving us information about purchases that happened in the company.

\n

\n Purchase Requisition KM Knowledge Model. In order to do that, we need to append the\nid of the Knowledge Model to the URL we used for the previous step. In the results we can get extra information for this\nKnowledge Model, for example that is extending another Knowledge Model with id open-purchase-requisition.purchase-requisition-km-base.

\n

\n \n \n

\n

5. Get KPIs for a Knowledge Model

\n

Imagine you want to retrieve all the KPIs within a Knowledge Model. This is possible just adding the Knowledge Model id,\nfor example open-purchase-requisition.purchase-requisition-km-base and later appending /kpis to the URL.

\n

\n \n \n

\n

6. Get data across any records & KPIs of a Knowledge Model

\n

Finally, it's time to consume the data from different records and KPIs of the Knowledge Model. For this we need to first append /data to the URL we got\nin 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\nin the Params tab named fields with the value MATERIALS.ACTIVITY and one with name kpis and the value AVG_EVENTS_PER_CASE,FILTERED_COUNT. The result:

\n

\n \n \n

","headings":[{"value":"Try it!","depth":1},{"value":"1. Create a new HTTP Request","depth":2},{"value":"2. Configure authentication","depth":2},{"value":"3. Get the list of Knowledge Models","depth":2},{"value":"4. Getting details for a specific Knowledge Model","depth":2},{"value":"5. Get KPIs for a Knowledge Model","depth":2},{"value":"6. Get data across any records & KPIs of a Knowledge Model","depth":2}]},"contentItem":{"data":{"lastModified":"2025-10-08T17:13:51.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"434f1d26-56c6-5529-918d-94f138c2e91a__redocly content/process-intelligence-apis/knowledge-model-api/api-reference/try-it/","seo":{"title":"Try it!","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/knowledge-model-api/api-reference/try-it.md","pageBaseUrl":"/process-intelligence-apis/knowledge-model-api/api-reference/try-it","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Try it!","id":"try-it"},{"depth":2,"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"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/knowledge-model-api/api-reference/try-it/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}