Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
A package represents an agent in the organization catalog. The Package Management API enables IT administrators to view and manage agents across your organization. This API provides endpoints to list all agents and retrieve detailed information about an individual agent, including metadata and detailed elements.
Important
Access to the Package Management API requires a Microsoft Agent 365 license.
Key capabilities
- Retrieve an inventory of all agents within the organization, optionally filtering by:
- Host (Copilot, Outlook, Teams)
- Platform (Copilot Studio, Microsoft 365 Copilot Agent Builder)
- Last updated time
- Element types contained in the agent package (bots, declarative agents, and more).
- Retrieve more metadata for a specific agent.
- Block, unblock, and reassign ownership of packages.
Example scenarios
- Organization admin retrieves the inventory of all agents.
- Admin reviews package details, including availability and deployment status.
- Admin reviews agent element details, including declarativeAgent or customEngineAgent element object.
- Admin blocks a package to prevent its usage across the organization.
- Admin reassigns package ownership when an employee leaves the organization.
API list
| Operation | HTTP Method | Description |
|---|---|---|
| List packages | GET /copilot/admin/catalog/packages |
Get all agents in the organization. |
| Get package details | GET /copilot/admin/catalog/packages/{id} |
Get detailed metadata for a specific agent. |
| Update package (preview) | PATCH /copilot/admin/catalog/packages/{id} |
Update package metadata. |
| Block (preview) | POST /copilot/admin/catalog/packages/{id}/block |
Block a package to prevent its usage. |
| Unblock (preview) | POST /copilot/admin/catalog/packages/{id}/unblock |
Unblock a package to allow its usage. |
| Reassign (preview) | POST /copilot/admin/catalog/packages/{id}/reassign |
Reassign ownership of a package to a different user. |