QI de Trabalho – Criar copilotConversation

Importante

As APIs sob a /beta versão estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção.

A API do Work IQ Chat permite que você crie e continue conversas de vários turnos com o Microsoft 365 Copilot, respeitando os controles de acesso definidos dentro da organização. Use a API de Chat para integrar o Microsoft 365 Copilot às suas soluções de IA generativa.

Esta documentação aborda a criação de conversas do Copilot usando a API de Chat. Saiba como continuar conversas síncronas ou conversas transmitidas com a API do Chat.

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) WorkIQAgent.Ask Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Authorization Bearer {token}. Obrigatório.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça um corpo JSON vazio.

Resposta

Se for bem-sucedida, essa ação retornará um código de 201 Created resposta e um copilotConversation no corpo da resposta.

Exemplo

O exemplo a seguir mostra como criar uma conversa do Copilot por meio da API do Work IQ Chat. Depois que a conversa é criada, o id no corpo da resposta é usado como um parâmetro de caminho para continuar a conversa, usando o endpoint síncrono ou o endpoint transmitido.

Solicitação

O exemplo a seguir mostra a solicitação.

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

{}

Resposta

O exemplo a seguir mostra a resposta.

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
}