Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Important
- This is a preview feature.
- Preview features aren’t meant for production use and might have restricted functionality. These features are subject to supplemental terms of use, and are available before an official release so that customers can get early access and provide feedback.
Agent APIs are a set of interfaces introduced in Microsoft Power Apps that allow model-driven apps to interact with topics created in Microsoft Copilot Studio. These APIs are available in two forms:
Xrm.Copilotnamespace used for client scripts in model-driven apps. This article describes these APIs.- PCF (for use in custom controls).
These APIs are designed to enhance integration with Microsoft Copilot Studio, enabling more intelligent and responsive app experiences. The APIs use a single Copilot Studio agent that is either:
- Interactive agent selected in the model app designer of custom apps. See more at Working with an interactive agent.
- Model app containing lead or opportunity table, which implicitly uses the "Copilot in Dynamics 365 Sales" agent.
| API | Description |
|---|---|
| Xrm.Copilot.executeEvent | Executes a Microsoft Copilot Studio topic based on the registered Event Name. Returns an array of type MCSResponse. |
| Xrm.Copilot.executePrompt | Executes a Microsoft Copilot Studio topic based on the trigger queries registered in the topic. Returns the array of type MCSResponse. |
Related articles
FAQ for Agent APIs and Agent Response component
Xrm.Copilot (Client API reference)
Xrm.Copilot.executeEvent (Client API reference)
Xrm.Copilot.executePrompt (Client API reference)
Working with an interactive agent
Copilot (Power Apps component framework API reference)