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

Getting Started

\n

This page describes how to get started with the AI domain of Process Intelligence APIs (Chat or Tools APIs) in a simple way using Postman.

\n

Prerequisites

\n
    \n
  1. \nYou need to have a \nProcess Copilot\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 AI API

\n

OAuth clients for Tools API should be configured with the scope:

\n\n

OAuth clients for Chat API should be configured with the scope:

\n\n

Client Permissions for AI API

\n

Process Copilot access is managed by studio package permissions.

\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 Copilot(s) you would like to access through AI API.

\n

You can grant access permissions by following these steps:

\n\n

Consuming the AI 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

First, append \"/ai/agents/\" plus the node id to the URL you used in the previous steps:\nPOST https://$team.$realm.celonis.cloud/intelligence/api/ai/agents/$copilot-id/conversations.

\n

After that, click the Send button next to the URL and you should see something like:

\n

\n