{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Semantic extensions of Knowledge Model API enabling AI Agents","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":"semantic-extensions-of-knowledge-model-api-enabling-ai-agents","__idx":0},"children":["Semantic extensions of Knowledge Model API enabling AI Agents"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Building up semantic understanding of Celonis data in a specific business context (Knowledge Model - KM) so that third-party (3P) AI Agents can figure out the right way to query Celonis data."," ","Therefore, the Knowledge Model API is being enhanced to provide:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Structure discovery"]},": A new endpoint focusing on the KM data structures (including schema and description)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content discovery"]},": A new endpoint providing statistical profiling of the data contents per KM record."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Relationship discovery"]},": To be added in the future."," ","Future extensions will include the supply of the necessary process context to the 3P AI agents to power business process automation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3p-ai-agent-enablement-beta-program","__idx":1},"children":["3P AI Agent Enablement (BETA program) ",{"$$mdtype":"Tag","name":"sup","attributes":{},"children":["[1]"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"knowledge-model-semantic-openapi-spec","__idx":2},"children":["Knowledge Model Semantic OpenAPI Spec"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To retrieve the semantic specification of a Knowledge Model - KM (according to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://spec.openapis.org/oas/latest.html"},"children":["Open API Initiative"]},"), either in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["json"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yml"]}," format, you need to consume the endpoint:"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /knowledge-models/{{km-id}}/spec"]}," ","You have the option to select either all KM records (including the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["auto-generated"]},") or only the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["curated"]}," ones by submitting the parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["curated=true"]},"."," ","The Knowledge Model semantic metadata, including ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["schema"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data descriptions"]},", are shared with the 3P agent enabling them to understand Celonis context and data."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"knowledge-model-record-semantic-data-content-statistics","__idx":3},"children":["Knowledge Model Record Semantic Data Content Statistics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To retrieve the Knowledge Model - KM record content statistics, you need to consume the endpoint:"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /knowledge-models/{{km-id}}/records/{{record-id}}/summary"]}," ","The results contain:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Schema"]}," array"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data Sample"]}," array"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Shape"]}," array (number of rows, number of columns"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Column Summary Statistics"]}," array including the following metrics for each KM record field (excluding KPIs, flags and augmented attributes):",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["count"]},": Number of non-null values (applicable to all field types)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unique"]},": Number of unique non-null values (applicable only to strings & timestamps)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["top"]},": Most frequent value (applicable only to strings & timestamps)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["freq"]},": Frequency of the most frequent value (applicable only to strings & timestamps)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mean"]},": Mean of the values (applicable only to numeric fields)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["std"]},": Standard deviation of the values (applicable only to numeric fields)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["min"]},": Minimum value (applicable only to numeric fields)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["max"]},": Maximum value (applicable only to numeric fields)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["25% percentile"]},": (applicable only to numeric fields)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["50% percentile"]},": (applicable only to numeric fields)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["75% percentile"]},": (applicable only to numeric fields)"," ","The optional parameters controlling which data will be analyzed are:"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},": The filters to be applied on data contents (column statistic profiling may differ significantly depending on the applied filter); default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]},": The fields whose contents will be analyzed (if omitted all record fields will be statistically profiled); default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["all"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeFields"]},": The fields to exclude from the statistical analysis; default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sampleSize"]},": For requesting a specific number of rows for the data; default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"knowledge-model-semantic-query","__idx":4},"children":["Knowledge Model Semantic Query"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To query the Knowledge Model, you need to consume the endpoint:"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /knowledge-models/{{km-id}}/query"]},". The parameters of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getKnowledgeModelQueryResult/"},"children":["/query"]}," are similar to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getRecordDataResult/"},"children":["/data"]}," endpoint with the difference that we have an optional parameter called ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kpis"]}," to retrieve the KPIs of the knowledge model."," ","The response format is structured as a json object compared to the array of name and value. You can refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getKnowledgeModelQueryResult/"},"children":["/query"]}," endpoint for more information."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"knowledge-model-record-semantic-query","__idx":5},"children":["Knowledge Model Record Semantic Query"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To query the Knowledge Model - KM record data, you need to consume the endpoint:"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /knowledge-models/{{km-id}}/records/{{record-id}}/query"]}," ","The same parameters as the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getRecordDataResult/"},"children":["/data"]}," endpoint are supported with the only difference that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fields"]}," is optional. If omitted, all KM record fields are included."," ","The response format is structured as a json object compared to the array of name. An example is provided here ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getRecordQueryResult/"},"children":["/record/query"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"fuzzy-search","__idx":6},"children":["Fuzzy Search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This feature fuzzy string search try to find the best match in a string."," ","It is found in the following endpoints: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getKnowledgeModelQueryResult/"},"children":["/query"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getRecordQueryResult/"},"children":["/record/query"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.celonis.com/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/operation/getRecordDataResult/"},"children":["/data"]},"."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"sup","attributes":{},"children":["[1]"]},":"]}," Contact your Celonis account team if you want to join the 3P AI Agent Enablement Beta program."]}]},"headings":[{"value":"Semantic extensions of Knowledge Model API enabling AI Agents","id":"semantic-extensions-of-knowledge-model-api-enabling-ai-agents","depth":1},{"value":"3P AI Agent Enablement (BETA program)","id":"3p-ai-agent-enablement-beta-program","depth":2},{"value":"Knowledge Model Semantic OpenAPI Spec","id":"knowledge-model-semantic-openapi-spec","depth":3},{"value":"Knowledge Model Record Semantic Data Content Statistics","id":"knowledge-model-record-semantic-data-content-statistics","depth":3},{"value":"Knowledge Model Semantic Query","id":"knowledge-model-semantic-query","depth":3},{"value":"Knowledge Model Record Semantic Query","id":"knowledge-model-record-semantic-query","depth":3},{"value":"Fuzzy Search","id":"fuzzy-search","depth":3}],"frontmatter":{"seo":{"title":"Semantic extensions of Knowledge Model API enabling AI Agents"}},"lastModified":"2026-03-16T19:48:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/process-intelligence-apis/knowledge-model-api/beta-features/ai/semantic","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}