root.copilotAgents object

Defines one or more agents to Microsoft 365 Copilot (formerly known as copilotExtensions). Declarative agents (formerly known as declarativeCopilots) are customizations of Microsoft 365 Copilot that run on the same orchestrator and foundation models. Custom engine agents are conversational Teams bots that use custom AI language models and orchestration, yet are selectable (along with installed declarative agents) as Agents from the Microsoft 365 Copilot side panel.

Properties that reference this object type:

• root.copilotAgents

Syntax

Syntax

{
  "declarativeAgents": [
    {
      "id": "{string}",
      "file": "{string}"
    }
  ],
  "customEngineAgents": [
    {
      "id": "{string}",
      "type": "bot"
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "declarativeAgents": {
      "type": "array",
      "description": "An array of declarative agent elements references. Currently, only one declarative agent per application is supported.",
      "items": {
        "$ref": "#/definitions/declarativeAgentRef"
      },
      "minItems": 1,
      "maxItems": 1
    },
    "customEngineAgents": {
      "type": "array",
      "description": "An array of Custom Engine Agents. Currently only one Custom Engine Agent per application is supported.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/definitions/guid",
            "description": "The id of the Custom Engine Agent. If it is of type bot, the id must match the id specified in a bot in the bots node and the referenced bot must have personal scope. The app short name and short description must also be defined."
          },
          "type": {
            "type": "string",
            "enum": [
              "bot"
            ],
            "description": "The type of the Custom Engine Agent. Currently only type bot is supported."
          }
        },
        "required": [
          "id",
          "type"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "maxItems": 1
    }
  },
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "declarativeAgents"
      ]
    },
    {
      "required": [
        "customEngineAgents"
      ]
    }
  ]
}

Syntax

{
  "declarativeAgents": [
    {
      "id": "{string}",
      "file": "{string}"
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "declarativeAgents": {
      "type": "array",
      "description": "An array of declarative agent elements references. Currently, only one declarative agent per application is supported.",
      "items": {
        "$ref": "#/definitions/declarativeAgentRef"
      },
      "minItems": 1,
      "maxItems": 1
    }
  },
  "additionalProperties": false,
  "required": [
    "declarativeAgents"
  ]
}

Properties

declarativeAgents

Array of objects that each define a declarative agent.

Type
Array of declarativeAgentRef

Required
—

Constraints
Minimum array items: 1. Maximum array items: 1.

Supported values

declarativeAgents

Array of objects that each define a declarative agent.

Type
Array of declarativeAgentRef

Required
✅

Constraints
Minimum array items: 1. Maximum array items: 1.

Supported values

customEngineAgents

Array of objects that each define a custom engine agent.

Type
Array of customEngineAgents

Required
—

Constraints
Minimum array items: 1. Maximum array items: 1.

Supported values

Remarks

Note

Custom engine agents support in Microsoft 365 Copilot is currently in limited private preview and not all developers have access during the staged rollout.

Examples

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