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

Getting Started

\n

This page describes how to get started with the Knowledge Model API in a simple way using Postman.

\n

Prerequisites

\n
    \n
  1. \nYou need to have a \nKnowledge Model\n available in your team.\n
    2. \n
  2. \nYou must request the activation of the API in your Celonis Platform Team to your Celonis account team.\n
    3. \n
\n

Authentication

\n

The authentication options applicable to all Celonis APIs are described here.

\n

Authorization

\n

OAuth Scopes for the Knowledge Model API

\n

OAuth clients for Knowledge Model API should be configured with the scope:

\n\n

Client Permissions for the Knowledge Model API

\n

You must set the right permissions\nand ensure the User API Key or the Application API Key leveraged for authorization\npurposes has access to the Celonis Platform Studio package\ncontaining the Knowledge Model(s) you would like to access through the Knowledge Model API.

\n

You can grant access permissions by following these steps:

\n\n

Consuming the Knowledge Model API

\n

Once you have completed the previous steps, you can start making requests to the API. For that you will use Postman (or any other REST client), which you should already have installed in our system.

\n
    \n
  1. \nGo to \nFile > New...\n and select \"HTTP Request\". Once you do this, you should see something like this:\n
    2. \n
\n

\n \n \n

\n

In the Content section, you will see a list of all your Knowledge Models. The Knowledge Models will be divided into pages. By default, the page size will be 50. If you have more than 50 Knowledge Models, you can navigate to\nthe following page, adding a \"page\" query parameter. The pages start at 0, so you can display the second page by setting a page value of 1.

\n

\n