{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/process-intelligence-apis/agents-api/overview/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#ai-api\" aria-label=\"ai api permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"ai-api\"></div>AI API</h1>\n<p>This documentation describes how to interact with the Celonis AI REST API. Please contact your account team to get early access.</p>\n<h2 style=\"position:relative;\"><a href=\"#goals\" aria-label=\"goals permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"goals\"></div>Goals</h2>\n<p>The AI API can be used to surface Process Copilots within other systems like Microsoft Teams, Slack or home-grown systems or to access tools for data retrieval explicitly built to be used in Agent Platforms like Microsoft Studio Copilot or Agentforce. </p>\n<p>Customers can configure the logic and behavior of the API within Celonis, tailored to the business problem they intend to solve, and then access these functionalities through the AI API. </p>\n<h2 style=\"position:relative;\"><a href=\"#chat-api\" aria-label=\"chat api permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"chat-api\"></div>Chat API</h2>\n<p>This is an API to interact with a Process Copilot built in Celonis (as described <a href=\"https://docs.celonis.com/en/set-up-process-copilots.html\">here</a>).</p>\n<h2 style=\"position:relative;\"><a href=\"#tools-api\" aria-label=\"tools api permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"tools-api\"></div>Tools API</h2>\n<p>This is an API to access data retrieval Tools built in Process Copilot. These tools can be called within any Agent platform (as described <a href=\"https://docs.celonis.com/en/tool-activation.html\">here</a>).</p>\n<ul>\n<li>\n<a href=\"https://developer.celonis.com/process-intelligence-apis/agents-api/api-reference/openapi/reference/operation/get-tool-api/\"><strong>GET</strong> request</a>\n: returns the Tools OpenAPI Contract (the consumer may select the Open API version they want) in JSON format including the endpoints of all available tools, their inputs and outputs.\n</li>\n<li>\n<a href=\"https://developer.celonis.com/process-intelligence-apis/agents-api/api-reference/openapi/reference/operation/post-tool-response/\"><strong>POST</strong> request</a>\n: executes the tool by submitting the tool identifier and their input parameters as specified in the OpenAPI contract and receives the response specified in the contract.\n</li>\n</ul>","headings":[{"value":"AI API","depth":1},{"value":"Goals","depth":2},{"value":"Chat API","depth":2},{"value":"Tools API","depth":2}]},"contentItem":{"data":{"lastModified":"2025-02-10T15:33:33.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"69618ec0-bdb0-59d7-8e58-5f1a99e22908__redocly content/process-intelligence-apis/agents-api/overview/","seo":{"title":"AI API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/agents-api/overview.md","pageBaseUrl":"/process-intelligence-apis/agents-api/overview","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"AI API","id":"ai-api"},{"depth":2,"value":"Goals","id":"goals"},{"depth":2,"value":"Chat API","id":"chat-api"},{"depth":2,"value":"Tools API","id":"tools-api"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/agents-api/overview/","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"]}