Work IQ – Erstellen von copilotConversation

Wichtig

APIs unter der /beta Version können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.

Mit der Work IQ Chat-API können Sie Unterhaltungen mit mehreren Durchläufen mit Microsoft 365 Copilot erstellen und fortsetzen, wobei die definierten Zugriffssteuerungen innerhalb der organization beachtet werden. Verwenden Sie die Chat-API, um Microsoft 365 Copilot in Ihre generativen KI-Lösungen zu integrieren.

In dieser Dokumentation wird das Erstellen von Copilot-Unterhaltungen mithilfe der Chat-API behandelt. Erfahren Sie, wie Sie synchrone Unterhaltungen oder gestreamte Unterhaltungen mit der Chat-API fortsetzen.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) WorkIQAgent.Ask Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application Nicht unterstützt Nicht unterstützt

HTTP-Anforderung

POST https://workiq.svc.cloud.microsoft/rest/conversations
POST https://workiq.svc.cloud.microsoft/rest/beta/conversations

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext einen leeren JSON-Text an.

Antwort

Bei erfolgreicher Ausführung gibt diese Aktion einen 201 Created Antwortcode und eine copilotConversation im Antworttext zurück.

Beispiel

Das folgende Beispiel zeigt, wie Sie eine Copilot-Unterhaltung über die Work IQ Chat-API erstellen. Nachdem die Konversation erstellt wurde, wird der id im Antworttext als Pfadparameter für die Fortsetzung der Konversation verwendet, wobei entweder der synchrone Endpunkt oder der gestreamte Endpunkt verwendet wird.

Anforderung

Das folgende Beispiel zeigt die Antwort.

POST https://workiq.svc.cloud.microsoft/rest/conversations
Content-Type: application/json

{}
POST https://workiq.svc.cloud.microsoft/rest/beta/conversations
Content-Type: application/json

{}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "0d110e7e-2b7e-4270-a899-fd2af6fde333",
  "createdDateTime": "2025-09-30T15:28:46.1560062Z",
  "displayName": "",
  "status": "active",
  "turnCount": 0
}