declarativeAgentRef object

Represents a customization of Microsoft 365 Copilot, as defined by its manifest file.

Properties that reference this object type:

• root.copilotAgents.declarativeAgents

Syntax

Syntax

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

Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique identifier for this declarative agent element."
    },
    "file": {
      "$ref": "#/definitions/relativePath",
      "description": "Relative file path to this declarative agent element file in the application package."
    }
  },
  "description": "A reference to a declarative agent element. The element\u0027s definition is in a separate file.",
  "required": [
    "id",
    "file"
  ],
  "additionalProperties": false
}

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"
            }
        ]
    }
}