root.copilotAgents.customEngineAgents object

Represents a conversational Teams bot that uses custom AI language models and orchestration, surfaced as an agent in the Microsoft 365 Copilot UI.

Properties that reference this object type:

• root.copilotAgents.customEngineAgents

Syntax

Syntax

{
  "id": "{string}",
  "type": "bot"
}

Schema

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

Properties

id

Unique (bot) identifier for the custom engine agent. Must match the botId specified in the bots section of the manifest, and the referenced bot must be of personal scope. The app short name and description must also be defined.

Type
string

Required
✅

Constraints

Supported values
The string value must be a guid.

type

Type of the custom engine agent.

Type
string

Required
✅

Constraints

Supported values
Allowed values: bot.