{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting Started","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":"getting-started","__idx":0},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page describes how to get started with the Knowledge Model API in a simple way using Postman."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You need to have a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.celonis.com/en/knowledge-models.html"},"children":["Knowledge Model"]}," available in your team."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must request the activation of the API in your Celonis Platform Team to your Celonis account team."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The authentication options applicable to all Celonis APIs are described ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/auth"},"children":["here"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authorization","__idx":3},"children":["Authorization"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"oauth-scopes-for-the-knowledge-model-api","__idx":4},"children":["OAuth Scopes for the Knowledge Model API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["OAuth clients for Knowledge Model API should be configured with the scope:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["intelligence.knowledge-models:read"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"client-permissions-for-the-knowledge-model-api","__idx":5},"children":["Client Permissions for the Knowledge Model API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.celonis.com/en/application-keys.html"},"children":["set the right permissions"]}," ","and ensure the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#authentication"},"children":["User API Key or the Application API Key"]}," leveraged for authorization"," ","purposes has access to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.celonis.com/en/studio.html#UUID-54a37cea-24d8-8459-8668-a517455a4e19_id_Studio-Workingwithpackages"},"children":["Celonis Platform Studio package"]}," ","containing the Knowledge Model(s) you would like to access through the Knowledge Model API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can grant access permissions by following these steps:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to the Studio package."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the three dots and select ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Permissions"]}," from the pop-up menu."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Search for the User (if you are using a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/auth#using-a-user-api-key"},"children":["Bearer token"]},") or AppKey (if you are using an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/auth#using-an-application-api-key"},"children":["AppKey"]},") and grant at least ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USE PACKAGE"]}," rights."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"consuming-the-knowledge-model-api","__idx":6},"children":["Consuming the Knowledge Model API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["File > New..."]}," and select \"HTTP Request\". Once you do this, you should see something like this:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/empty-request.ac1ad5f8efa25bb14a1aa72e1369c8c4f98929781e1524b89a36dfaa541202a1.3c53a942.png","alt":"Postman empty request"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter the request URL next to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send"]}," button. For this URL you will use the one from the \"Determine the"," ","URL for your team\" section: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://dev.us-2.celonis.cloud/intelligence/api"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now you need to set your API or Application Key in order to authenticate our requests. To do this, click on the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Headers"]}," tab beneath the URL you just entered. Enter \"Authorization\" as the Key and for Value, enter:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer <YOUR_KEY>"]}," if you have a User API Key"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AppKey <YOUR_KEY>"]}," if you have a AppKey"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the following example, you have an AppKey:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/auth.2462db50559d8d8daaa1d69d3a5af216ef74814cd09ac745d83b9726fc5a5f58.3c53a942.png","alt":"Postman authentication section"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getting-the-list-of-knowledge-models","__idx":7},"children":["Getting the list of Knowledge Models"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have completed the steps above, you should now be able to start getting some data. You will start getting the"," ","full list of Knowledge Models that your API token has access to."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["First, append ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/knowledge-models"]}," to the URL you used in the previous steps like this:"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://dev.us-2.celonis.cloud/intelligence/api/knowledge-models"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Next, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send"]}," button next to the URL and you should see something similar to this:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/knowledge-models.1689be958259b96c9cfa13712cf6bd227d18eab5f371ff290ea005a53a6c66c2.3c53a942.png","alt":"Knowledge Models response"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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"," ","the following page, adding a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," query parameter. Pages start at 0, so you can display the second page by setting a page value of \"1\"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/page.0ddffa38139434693bea15e4498382c37e0cc648608658182bf8115628cd1cb6.3c53a942.png","alt":"Setting a page query parameter"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this example, this is not needed as there are only 13 Knowledge Models. However, you might want to specify other query"," ","parameters such as:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageSize:"]}," Sets the size of each page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["sort:"]}," Sort the results by id or name."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can check the full list of parameters and possible responses ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getKnowledgeModel/"},"children":["from this page"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/process-intelligence-apis/knowledge-model-api/api-reference/error-catalog"},"children":["check the full list of possible errors"]}," that you can receive in the API, in case you need to troubleshoot any issue."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this guide, you created your first request to the Knowledge Model API. If you would like to do more advanced requests, we recommend that you check the full list of capabilities of this API or review ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/process-intelligence-apis/knowledge-model-api/tutorials/learning/exploring-schema"},"children":["this guide that walks you through the rest of schema endpoints"]},"."]}]},"headings":[{"value":"Getting Started","id":"getting-started","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Authentication","id":"authentication","depth":3},{"value":"Authorization","id":"authorization","depth":3},{"value":"OAuth Scopes for the Knowledge Model API","id":"oauth-scopes-for-the-knowledge-model-api","depth":4},{"value":"Client Permissions for the Knowledge Model API","id":"client-permissions-for-the-knowledge-model-api","depth":4},{"value":"Consuming the Knowledge Model API","id":"consuming-the-knowledge-model-api","depth":2},{"value":"Getting the list of Knowledge Models","id":"getting-the-list-of-knowledge-models","depth":3}],"frontmatter":{"seo":{"title":"Getting Started"}},"lastModified":"2026-03-04T21:34:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/process-intelligence-apis/knowledge-model-api/get-started/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}