openapi: 3.1.0 info: title: Microsoft Graph Copilot description: Needs a description. paths: /copilot: description: Provides operations to manage the copilotRoot singleton. get: tags: - copilot.copilotRoot summary: Microsoft Graph Get copilot operationId: copilot.copilotRoot.GetCopilotRoot parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotRoot' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - copilot.copilotRoot summary: Microsoft Graph Update copilot operationId: copilot.copilotRoot.UpdateCopilotRoot requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotRoot' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotRoot' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /copilot/admin: description: >- Provides operations to manage the admin property of the microsoft.graph.copilotRoot entity. get: tags: - copilot.copilotAdmin summary: Microsoft Graph Get admin from copilot operationId: copilot.GetAdmin parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdmin' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - copilot.copilotAdmin summary: Microsoft Graph Update the navigation property admin in copilot operationId: copilot.UpdateAdmin requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdmin' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdmin' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - copilot.copilotAdmin summary: Microsoft Graph Delete navigation property admin for copilot operationId: copilot.DeleteAdmin parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /copilot/admin/settings: description: >- Provides operations to manage the settings property of the microsoft.graph.copilotAdmin entity. get: tags: - copilot.copilotAdmin summary: Microsoft Graph Get settings from copilot operationId: copilot.admin.GetSettings parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdminSetting' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - copilot.copilotAdmin summary: Microsoft Graph Update the navigation property settings in copilot operationId: copilot.admin.UpdateSettings requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdminSetting' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdminSetting' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - copilot.copilotAdmin summary: Microsoft Graph Delete navigation property settings for copilot operationId: copilot.admin.DeleteSettings parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /copilot/admin/settings/limitedMode: description: >- Provides operations to manage the limitedMode property of the microsoft.graph.copilotAdminSetting entity. get: tags: - copilot.copilotAdmin summary: Microsoft Graph Get limitedMode from copilot operationId: copilot.admin.settings.GetLimitedMode parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdminLimitedMode' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - copilot.copilotAdmin summary: Microsoft Graph Update the navigation property limitedMode in copilot operationId: copilot.admin.settings.UpdateLimitedMode requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdminLimitedMode' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotAdminLimitedMode' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - copilot.copilotAdmin summary: Microsoft Graph Delete navigation property limitedMode for copilot operationId: copilot.admin.settings.DeleteLimitedMode parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /copilot/interactionHistory: description: >- Provides operations to manage the interactionHistory property of the microsoft.graph.copilotRoot entity. get: tags: - copilot.aiInteractionHistory summary: Microsoft Graph Get interactionHistory from copilot operationId: copilot.GetInteractionHistory parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - copilot.aiInteractionHistory summary: Microsoft Graph Update the navigation property interactionHistory in copilot operationId: copilot.UpdateInteractionHistory requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - copilot.aiInteractionHistory summary: Microsoft Graph Delete navigation property interactionHistory for copilot operationId: copilot.DeleteInteractionHistory parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /copilot/interactionHistory/getAllEnterpriseInteractions(): description: Provides operations to call the getAllEnterpriseInteractions method. get: tags: - copilot.aiInteractionHistory summary: Microsoft Graph Invoke function getAllEnterpriseInteractions operationId: copilot.interactionHistory.getAllEnterpriseInteractions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Success content: application/json: schema: title: Collection of aiInteraction type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.aiInteraction' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-grouped-path: - >- /copilot/users/{aiUser-id}/interactionHistory/getAllEnterpriseInteractions() /copilot/retrieval: description: Provides operations to call the retrieval method. post: tags: - copilot.copilotRoot.Actions summary: Microsoft Graph Invoke action retrieval operationId: copilot.retrieval requestBody: description: Action parameters content: application/json: schema: type: object properties: queryString: type: string dataSource: anyOf: - $ref: '#/components/schemas/microsoft.graph.retrievalDataSource' - type: object nullable: true filterExpression: type: string nullable: true resourceMetadata: type: array items: type: string nullable: true maximumNumberOfResults: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true dataSourceConfiguration: anyOf: - $ref: >- #/components/schemas/microsoft.graph.dataSourceConfiguration - type: object nullable: true required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.retrievalResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-12-31' date: '2024-02-23' version: 2024-12/PrivatePreview:retrievalAPI x-ms-docs-operation-type: action /copilot/reports: description: >- Provides operations to manage the reports property of the microsoft.graph.copilotRoot entity. get: tags: - copilot.copilotReportRoot summary: Microsoft Graph Get reports from copilot operationId: copilot.GetReports parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.copilotReportRoot' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /copilot/users: description: >- Provides operations to manage the users property of the microsoft.graph.copilotRoot entity. get: tags: - copilot.aiUser summary: Microsoft Graph Get users from copilot operationId: copilot.ListUsers parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/microsoft.graph.aiUserCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - copilot.aiUser summary: Microsoft Graph Create new navigation property to users for copilot operationId: copilot.CreateUsers requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiUser' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiUser' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /copilot/users/{aiUser-id}: description: >- Provides operations to manage the users property of the microsoft.graph.copilotRoot entity. get: tags: - copilot.aiUser summary: Microsoft Graph Get users from copilot operationId: copilot.GetUsers parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiUser' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - copilot.aiUser summary: Microsoft Graph Update the navigation property users in copilot operationId: copilot.UpdateUsers requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiUser' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiUser' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - copilot.aiUser summary: Microsoft Graph Delete navigation property users for copilot operationId: copilot.DeleteUsers parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: aiUser-id in: path description: The unique identifier of aiUser required: true schema: type: string x-ms-docs-key-type: aiUser /copilot/users/{aiUser-id}/interactionHistory: description: >- Provides operations to manage the interactionHistory property of the microsoft.graph.aiUser entity. get: tags: - copilot.aiUser summary: Microsoft Graph Get interactionHistory from copilot operationId: copilot.users.GetInteractionHistory parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - copilot.aiUser summary: Microsoft Graph Update the navigation property interactionHistory in copilot operationId: copilot.users.UpdateInteractionHistory requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - copilot.aiUser summary: Microsoft Graph Delete navigation property interactionHistory for copilot operationId: copilot.users.DeleteInteractionHistory parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: aiUser-id in: path description: The unique identifier of aiUser required: true schema: type: string x-ms-docs-key-type: aiUser /copilot/users/{aiUser-id}/interactionHistory/getAllEnterpriseInteractions(): description: Provides operations to call the getAllEnterpriseInteractions method. get: tags: - copilot.aiUser summary: Microsoft Graph Invoke function getAllEnterpriseInteractions operationId: copilot.users.aiUser.interactionHistory.getAllEnterpriseInteractions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Success content: application/json: schema: title: Collection of aiInteraction type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.aiInteraction' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: aiUser-id in: path description: The unique identifier of aiUser required: true schema: type: string x-ms-docs-key-type: aiUser x-ms-docs-grouped-path: - /copilot/interactionHistory/getAllEnterpriseInteractions() /copilot/users/$count: description: Provides operations to count the resources in the collection. get: tags: - copilot.aiUser summary: Microsoft Graph Get the number of the resource operationId: copilot.users.GetCount-2ed5 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' components: schemas: microsoft.graph.copilotRoot: title: copilotRoot required: - '@odata.type' type: object properties: admin: anyOf: - $ref: '#/components/schemas/microsoft.graph.copilotAdmin' - type: object nullable: true x-ms-navigationProperty: true interactionHistory: anyOf: - $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' - type: object nullable: true x-ms-navigationProperty: true reports: anyOf: - $ref: '#/components/schemas/microsoft.graph.copilotReportRoot' - type: object nullable: true x-ms-navigationProperty: true users: type: array items: $ref: '#/components/schemas/microsoft.graph.aiUser' x-ms-navigationProperty: true '@odata.type': type: string microsoft.graph.copilotAdmin: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: copilotAdmin required: - '@odata.type' type: object properties: settings: anyOf: - $ref: '#/components/schemas/microsoft.graph.copilotAdminSetting' - type: object nullable: true x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.copilotAdmin' microsoft.graph.copilotAdminSetting: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: copilotAdminSetting required: - '@odata.type' type: object properties: limitedMode: anyOf: - $ref: '#/components/schemas/microsoft.graph.copilotAdminLimitedMode' - type: object nullable: true x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.copilotAdminSetting' microsoft.graph.copilotAdminLimitedMode: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: copilotAdminLimitedMode required: - '@odata.type' type: object properties: groupId: type: string nullable: true isEnabledForGroup: type: boolean nullable: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.copilotAdminLimitedMode' microsoft.graph.aiInteractionHistory: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: aiInteractionHistory required: - '@odata.type' type: object properties: '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.aiInteractionHistory' BaseCollectionPaginationCountResponse: title: Base collection pagination and count responses type: object properties: '@odata.count': type: integer format: int64 nullable: true '@odata.nextLink': type: string nullable: true microsoft.graph.aiInteraction: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: aiInteraction required: - '@odata.type' type: object properties: appClass: type: string attachments: type: array items: $ref: '#/components/schemas/microsoft.graph.aiInteractionAttachment' body: anyOf: - $ref: '#/components/schemas/microsoft.graph.itemBody' - type: object nullable: true contexts: type: array items: $ref: '#/components/schemas/microsoft.graph.aiInteractionContext' conversationType: type: string nullable: true createdDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string format: date-time nullable: true etag: type: string nullable: true from: $ref: '#/components/schemas/microsoft.graph.identitySet' interactionType: $ref: '#/components/schemas/microsoft.graph.aiInteractionType' links: type: array items: $ref: '#/components/schemas/microsoft.graph.aiInteractionLink' locale: type: string mentions: type: array items: $ref: '#/components/schemas/microsoft.graph.aiInteractionMention' requestId: type: string sessionId: type: string '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.aiInteraction' microsoft.graph.retrievalDataSource: title: retrievalDataSource enum: - sharePoint - oneDriveBusiness - externalItem - unknownFutureValue type: string microsoft.graph.retrievalResponse: title: retrievalResponse required: - '@odata.type' type: object properties: retrievalHits: type: array items: $ref: '#/components/schemas/microsoft.graph.retrievalHit' '@odata.type': type: string microsoft.graph.copilotReportRoot: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: copilotReportRoot required: - '@odata.type' type: object properties: '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.copilotReportRoot' microsoft.graph.aiUser: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: aiUser required: - '@odata.type' type: object properties: interactionHistory: anyOf: - $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory' - type: object nullable: true x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.aiUser' parameters: top: name: $top in: query description: Show only the first n items style: form explode: false schema: minimum: 0 type: integer example: 50 skip: name: $skip in: query description: Skip the first n items style: form explode: false schema: minimum: 0 type: integer search: name: $search in: query description: Search items by search phrases style: form explode: false schema: type: string filter: name: $filter in: query description: Filter items by property values style: form explode: false schema: type: string count: name: $count in: query description: Include count of items style: form explode: false schema: type: boolean examples: {} responses: error: description: error content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError' microsoft.graph.aiUserCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.aiUserCollectionResponse' ODataCountResponse: description: The count of the resource content: text/plain: schema: $ref: '#/components/schemas/ODataCountResponse' tags: - name: copilot.aiInteractionHistory - name: copilot.aiUser - name: copilot.copilotAdmin - name: copilot.copilotReportRoot - name: copilot.copilotRoot - name: copilot.copilotRoot.Actions