Share via


declarativeAgentRef object

Declarative agents are customizations of Microsoft 365 Copilot that run on the same orchestrator and foundation models. The agents extend the capabilities of Microsoft 365 Copilot's through domain-specific customizations of knowledge and skills to fit the business needs of your users. The agent's behavior and configuration are defined in a separate manifest file that specifies its capabilities. To learn more, see Overview of declarative agents.

Properties that reference this object type:

Syntax

{
  "id": "{string}",
  "file": "{string}"
}

Properties

id

Unique identifier for the agent. When using Microsoft Copilot Studio to build agents, this is auto-generated. Otherwise, manually assign the value according to your own conventions or preference.

Type
string

Required

Constraints

Supported values

file

Relative path within the app package to the declarative agent manifest file.

Type
string

Required

Constraints
Maximum string length: 2048.

Supported values

Examples

{
    "copilotAgents": {
        "declarativeAgents": [
            {
                "id": "agent1",
                "file": "declarativeAgent1.json"
            }
        ]
    }
}