{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/process-intelligence-apis/agents-api/api-reference/openapi/reference/operation/get-tool-api/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/process-intelligence-apis/agents-api/api-reference/openapi/reference/operation/get-tool-api/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"OpenAPI Specification\",\"description\":\"AI API to chat with Celonis Agents and run their tools.\",\"x-audience\":\"EX\",\"version\":\"1.1.0\"},\"security\":[{\"BearerAuth\":[]},{\"ApiKeyAuth\":[]}],\"servers\":[{\"url\":\"https://30f873b4-88d4-49ba-b327-6f651d7b99e6.remockly.com\"}],\"paths\":{\"/intelligence/api/ai/agents/{agent_id}/conversations\":{\"post\":{\"tags\":[\"Agents - Conversation\"],\"operationId\":\"pushConversations\",\"summary\":\"Post Conversation Message\",\"description\":\"Posts a conversation message to an asset, optionally with a conversation id.\\nAlways returns a text response for external use cases.\",\"parameters\":[{\"name\":\"agent_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"agent\"}}],\"requestBody\":{\"description\":\"Message details\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Message\"}}}},\"responses\":{\"200\":{\"description\":\"Return agent id\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ChatResponse\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"},\"default\":{\"$ref\":\"#/components/responses/DefaultResponse\"}}}},\"/intelligence/api/ai/agents/{agent_id}/tools/spec\":{\"get\":{\"operationId\":\"get-tool-api\",\"tags\":[\"Agents - Tools\"],\"summary\":\"Get the agent tools OpenAPI specification\",\"description\":\"Get the agent tools OpenAPI specification which contains all the endpoints to execute the agent's tool\",\"parameters\":[{\"name\":\"agent_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"1234a123-12a1-12a1-1a1a-1a1abc12abc1\"}}],\"responses\":{\"200\":{\"description\":\"OpenAPI specification in JSON format\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"},\"default\":{\"$ref\":\"#/components/responses/DefaultResponse\"}}}},\"/intelligence/api/ai/agents/{agent_id}/tools/{tool_id}\":{\"post\":{\"operationId\":\"post-tool-response\",\"tags\":[\"Agents - Tools\"],\"summary\":\"Execute Tool\",\"description\":\"Execute a given agent tool.\",\"parameters\":[{\"name\":\"agent_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"1234a123-12a1-12a1-1a1a-1a1abc12abc1\"}},{\"name\":\"tool_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"tool_defined_name\"}}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"example\":{\"kpi\":\"KIP_DEFINED_NAME\",\"field_ids\":[\"record.field_name\"]}}}}},\"responses\":{\"200\":{\"description\":\"Return results in Dynamic JSON format\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"example\":{\"kpis_and_attributes\":[{\"search_term\":\"invoice\",\"results\":[{\"id\":\"INVOICES.INVOICE_VALUE\",\"display_name\":\"Invoice Value\",\"column_type\":\"FLOAT\",\"type\":\"record\",\"score\":0.75}]}]}}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"},\"default\":{\"$ref\":\"#/components/responses/DefaultResponse\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\",\"bearerFormat\":\"JWT\"},\"ApiKeyAuth\":{\"type\":\"apiKey\",\"in\":\"header\",\"name\":\"AppKey\"}},\"schemas\":{\"Problem\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"format\":\"uri-reference\",\"description\":\"A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is not recommended that it be dereferenceable and point to a human-readable documentation or be globally unique for the problem type.\\n\",\"default\":\"about:blank\",\"example\":\"/some/uri-reference\"},\"title\":{\"type\":\"string\",\"description\":\"A short summary of the problem type. Written in English and readable for engineers. Usually not suited for non technical stakeholders and not localized.\\n\",\"example\":\"some title for the error situation\"},\"status\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The HTTP status code generated by the origin server for this occurrence of the problem.\\n\",\"minimum\":100,\"maximum\":600,\"exclusiveMaximum\":true},\"detail\":{\"type\":\"string\",\"description\":\"A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers. Usually not suited for non technical stakeholders and not localized.\\n\",\"example\":\"some description for the error situation\"},\"instance\":{\"type\":\"string\",\"format\":\"uri-reference\",\"description\":\"A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.\\n\",\"example\":\"/some/uri-reference#specific-occurrence-context\"}}},\"ChatResponse\":{\"title\":\"ChatResponse\",\"description\":\"Hits conversations of an specific agent\",\"type\":\"object\",\"properties\":{\"conversationId\":{\"type\":\"string\",\"description\":\"Conversation identifier\",\"example\":\"abc-def-ghi-etc\"},\"text\":{\"type\":\"string\",\"description\":\"Text from Chat\",\"example\":\"this is an example\"}}},\"Message\":{\"title\":\"Message chat\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"message\":{\"type\":\"string\"},\"conversationId\":{\"type\":\"string\"}},\"required\":[\"message\"]}},\"responses\":{\"BadRequest\":{\"description\":\"Bad Request.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"Unauthorized\":{\"description\":\"Unauthorized access.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"Forbidden\":{\"description\":\"Forbidden.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"NotFound\":{\"description\":\"The specified resource was not found\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"TooManyRequests\":{\"description\":\"Too Many Requests.\",\"headers\":{\"X-RateLimit-Limit\":{\"description\":\"Request limit per hour.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Remaining\":{\"description\":\"The number of requests left for the time window.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Reset\":{\"description\":\"The UTC date/time at which the current rate limit window resets.\",\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}},\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"InternalError\":{\"description\":\"Internal Server Error.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"ServiceUnavailable\":{\"description\":\"Service Unavailable.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"DefaultResponse\":{\"description\":\"Default error\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"PHP\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/process-intelligence-apis/agents-api/api-reference/openapi/reference/overview/","redocItemId":"tag/Agents-Tools/operation/get-tool-api","redocHasInfoPage":false,"settings":{"corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]}},"requestLogin":false,"lastModified":"2025-10-07T16:52:38.000Z"},"seo":{"title":"Get the agent tools OpenAPI specification"}}},"pageContext":{"id":"d73347a9-bba7-5160-9381-4bdb5ed1411aoperation/get-tool-api__redocly content/process-intelligence-apis/agents-api/api-reference/openapi/reference/operation/get-tool-api/","seo":{"title":"Get the agent tools OpenAPI specification","description":"Get the agent tools OpenAPI specification which contains all the endpoints to execute the agent's tool","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/agents-api/api-reference/openapi/reference.page.yaml#operation/get-tool-api","pageBaseUrl":"/process-intelligence-apis/agents-api/api-reference/openapi/reference","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/process-intelligence-apis/agents-api/api-reference/openapi/reference/operation/get-tool-api/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"agents-api","id":"agents-api","title":"agents-api","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}