Skip to main content
PATCH
/
chats
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "title": "<string>",
  "createdBy": "<string>",
  "isPublic": true,
  "owners": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "mail": "<string>",
      "securityEnabled": true,
      "mailEnabled": true,
      "groupTypes": [
        "<string>"
      ],
      "groupType": "<string>",
      "userPrincipalName": "<string>",
      "jobTitle": "<string>",
      "department": "<string>",
      "officeLocation": "<string>"
    }
  ],
  "contributors": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "mail": "<string>",
      "securityEnabled": true,
      "mailEnabled": true,
      "groupTypes": [
        "<string>"
      ],
      "groupType": "<string>",
      "userPrincipalName": "<string>",
      "jobTitle": "<string>",
      "department": "<string>",
      "officeLocation": "<string>"
    }
  ],
  "users": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "mail": "<string>",
      "securityEnabled": true,
      "mailEnabled": true,
      "groupTypes": [
        "<string>"
      ],
      "groupType": "<string>",
      "userPrincipalName": "<string>",
      "jobTitle": "<string>",
      "department": "<string>",
      "officeLocation": "<string>"
    }
  ],
  "inheritEntitlements": true,
  "hideFromCatalog": true,
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "updatedAt": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "icon": "<string>",
  "dataSources": [
    {
      "id": "<string>",
      "indexName": "<string>",
      "datasourceId": "<string>",
      "searchEndpoint": "<string>",
      "weight": 123,
      "maxResults": 123,
      "filter": "<string>",
      "label": "<string>",
      "enabled": true,
      "enableAclFiltering": true,
      "allowUserToggle": true,
      "allowUserWeightEdit": true,
      "allowUserMaxResultsEdit": true,
      "selectedFolder": "<string>",
      "flowId": "<string>",
      "flowParams": {},
      "lockedFlowParams": [
        "<string>"
      ],
      "hiddenFlowParams": [
        "<string>"
      ],
      "retrieverInstructions": "<string>",
      "vectorConnectionId": "<string>",
      "vectorIndex": "<string>",
      "vectorTopK": 123,
      "vectorMinScore": 123,
      "webSearch": {
        "provider": "<string>",
        "config": {
          "maxResults": 123,
          "includeAnswer": true,
          "includeDomains": [
            "<string>"
          ],
          "excludeDomains": [
            "<string>"
          ],
          "pinnedUrls": [
            "<string>"
          ]
        },
        "allowUserToggle": true,
        "allowUserPinnedUrlEdit": true,
        "allowUserIncludeDomainEdit": true,
        "allowUserExcludeDomainEdit": true
      },
      "sharePointSite": {},
      "sharePointLibrary": {},
      "sharePointLibraries": [
        {}
      ],
      "sharePointIndexEntireSite": true,
      "sharePointFolder": {}
    }
  ],
  "deduplicateResults": true,
  "sort": 123,
  "enableFeedback": true,
  "hideFilesAndCitationsFromUsers": true,
  "embeddedAgentMode": true,
  "hidePromptsOnChatCanvas": true,
  "modelEndpoint": "<string>",
  "searchEndpoint": "<string>",
  "defaultModel": "<string>",
  "models": [
    "<string>"
  ],
  "pageId": "<string>",
  "promptGroupId": "<string>",
  "aiOptions": {
    "maxTokens": 123,
    "topP": 123,
    "threshold": 123,
    "temperature": 123,
    "topNDocuments": 123,
    "vectorTopNDocuments": 123,
    "strictness": 123,
    "systemPrompt": "<string>",
    "filter": "<string>",
    "semanticConfigurationName": "<string>"
  },
  "memoryEnabled": true,
  "memoryReadScopes": [],
  "autoStoreConversations": true,
  "memoryRetentionDays": 123,
  "memorySearchLimit": 123,
  "memoryTokenBudget": 123,
  "memoryTokenBudgetPercent": 123,
  "preventUserDisableUserGlobalMemories": true,
  "preventUserDisableUserChatMemories": true,
  "preventUserDisableOrgChatMemories": true,
  "flowEngineFlowId": "<string>",
  "flowEngineEnabled": true,
  "promptForFlowVariables": true,
  "prefilledFlowVariables": {},
  "lockedFlowVariables": [
    "<string>"
  ],
  "hiddenFlowVariables": [
    "<string>"
  ],
  "autoSubmitLockedDefaults": true,
  "enabledMCPServers": [
    "<string>"
  ],
  "mcpServerConfigs": {},
  "isFeatured": true,
  "tags": [
    "<string>"
  ],
  "defaultCompletionCriteria": "<string>",
  "defaultMaxAttempts": 123,
  "defaultAllowDelegation": true,
  "defaultAllowRejection": true,
  "isWorkspace": true
}

Authorizations

Authorization
string
header
required

Azure AD access token obtained via MSAL

Path Parameters

id
string<uuid>
required

Body

application/json

Chat tab configuration with multi-source RAG, ACL, and feature flags

id
string
required

Chat ID (UUID)

title
string
required
scope
enum<string>

Access control model

Available options:
personal,
shared
createdBy
string

UPN of the creator

isPublic
boolean

Allow public read access

owners
object[]
contributors
object[]
users
object[]
inheritEntitlements
hideFromCatalog
boolean

Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins)

createdAt
string

ISO-8601 creation timestamp

updatedBy
string
updatedAt
string

ISO-8601 update timestamp

description
string
instructions
string

Markdown-formatted instructions displayed in the chat canvas

icon
string

MUI icon name for navigation display

dataSources
DataSourceConfig · object[]

Array of data sources for multi-source RAG (empty = LLM only)

deduplicateResults
boolean

Remove duplicate docs across sources

resultMergeStrategy
enum<string>

How to merge multi-source results

Available options:
interleave,
weighted,
sequential
sort
integer
enableFeedback
boolean
hideFilesAndCitationsFromUsers
boolean

When true, only admins/owners/contributors see files and citations

embeddedAgentMode
boolean

When true, shows only chat canvas without navigation elements

hidePromptsOnChatCanvas
boolean

When true, hides the prompt selector on the canvas

modelEndpoint
string | null

FK to AI model endpoint

searchEndpoint
string | null

FK to AI Search endpoint

defaultModel
string
models
string[] | null
searchLevel
enum<string> | null
Available options:
basic,
premium
pageId
string

FK to Page for dynamic navigation

promptGroupId
string | null

FK to prompt group for curated prompt templates

aiOptions
object

AI inference options — undefined means use system defaults

memoryEnabled
boolean
memoryReadScopes
enum<string>[]

Scopes to read memories from (includes orgGlobal for admin-managed memories)

Available options:
userGlobal,
userChat,
orgGlobal,
orgChat
memoryWriteScope
enum<string>

Scope to write new memories to (excludes orgGlobal — admin only)

Available options:
userGlobal,
userChat,
orgGlobal,
orgChat
autoStoreConversations
boolean
memoryRetentionDays
integer
memorySearchLimit
integer
memoryTokenBudget
integer
memoryTokenBudgetPercent
integer

Max % of model context for memory (1-20%, default: 5%)

memoryRetrievalStrategy
enum<string>
Available options:
semantic,
recency,
hybrid,
semantic_keyword,
all
preventUserDisableUserGlobalMemories
boolean

Lock User's Private Memories (USER_GLOBAL) — users cannot disable

preventUserDisableUserChatMemories
boolean

Lock User's Private Chat Memories (USER_CHAT) — users cannot disable

preventUserDisableOrgChatMemories
boolean

Lock This Chat's Shared Memories (ORG_CHAT) — users cannot disable

flowEngineFlowId
string

FK to FlowEngine flow

flowEngineEnabled
boolean
promptForFlowVariables
boolean

Show entry prompt form on chat start to collect flow variables

prefilledFlowVariables
object

Pre-filled values for flow entry prompt variables

lockedFlowVariables
string[]

Variable names that end users cannot override

hiddenFlowVariables
string[]

Variable names hidden from end users at runtime

autoSubmitLockedDefaults
boolean

When true and all variables are locked+filled, skip entry prompt

enabledMCPServers
string[]

Array of MCP server IDs enabled for this chat

mcpServerConfigs
object

Per-chat config overrides for MCP servers

Whether this chat is featured/promoted in the catalog

tags
string[]
defaultCompletionCriteria
string

ASSIGNMENT_COMPLETION_CRITERIA — default completion criteria for assignments

defaultMaxAttempts
integer
defaultAllowDelegation
boolean
defaultAllowRejection
boolean
isWorkspace
boolean

Server-only: true when request targets the ephemeral cross-chat workspace. Never persisted.

Response

Chat patched

Chat tab configuration with multi-source RAG, ACL, and feature flags

id
string
required

Chat ID (UUID)

title
string
required
scope
enum<string>

Access control model

Available options:
personal,
shared
createdBy
string

UPN of the creator

isPublic
boolean

Allow public read access

owners
object[]
contributors
object[]
users
object[]
inheritEntitlements
hideFromCatalog
boolean

Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins)

createdAt
string

ISO-8601 creation timestamp

updatedBy
string
updatedAt
string

ISO-8601 update timestamp

description
string
instructions
string

Markdown-formatted instructions displayed in the chat canvas

icon
string

MUI icon name for navigation display

dataSources
DataSourceConfig · object[]

Array of data sources for multi-source RAG (empty = LLM only)

deduplicateResults
boolean

Remove duplicate docs across sources

resultMergeStrategy
enum<string>

How to merge multi-source results

Available options:
interleave,
weighted,
sequential
sort
integer
enableFeedback
boolean
hideFilesAndCitationsFromUsers
boolean

When true, only admins/owners/contributors see files and citations

embeddedAgentMode
boolean

When true, shows only chat canvas without navigation elements

hidePromptsOnChatCanvas
boolean

When true, hides the prompt selector on the canvas

modelEndpoint
string | null

FK to AI model endpoint

searchEndpoint
string | null

FK to AI Search endpoint

defaultModel
string
models
string[] | null
searchLevel
enum<string> | null
Available options:
basic,
premium
pageId
string

FK to Page for dynamic navigation

promptGroupId
string | null

FK to prompt group for curated prompt templates

aiOptions
object

AI inference options — undefined means use system defaults

memoryEnabled
boolean
memoryReadScopes
enum<string>[]

Scopes to read memories from (includes orgGlobal for admin-managed memories)

Available options:
userGlobal,
userChat,
orgGlobal,
orgChat
memoryWriteScope
enum<string>

Scope to write new memories to (excludes orgGlobal — admin only)

Available options:
userGlobal,
userChat,
orgGlobal,
orgChat
autoStoreConversations
boolean
memoryRetentionDays
integer
memorySearchLimit
integer
memoryTokenBudget
integer
memoryTokenBudgetPercent
integer

Max % of model context for memory (1-20%, default: 5%)

memoryRetrievalStrategy
enum<string>
Available options:
semantic,
recency,
hybrid,
semantic_keyword,
all
preventUserDisableUserGlobalMemories
boolean

Lock User's Private Memories (USER_GLOBAL) — users cannot disable

preventUserDisableUserChatMemories
boolean

Lock User's Private Chat Memories (USER_CHAT) — users cannot disable

preventUserDisableOrgChatMemories
boolean

Lock This Chat's Shared Memories (ORG_CHAT) — users cannot disable

flowEngineFlowId
string

FK to FlowEngine flow

flowEngineEnabled
boolean
promptForFlowVariables
boolean

Show entry prompt form on chat start to collect flow variables

prefilledFlowVariables
object

Pre-filled values for flow entry prompt variables

lockedFlowVariables
string[]

Variable names that end users cannot override

hiddenFlowVariables
string[]

Variable names hidden from end users at runtime

autoSubmitLockedDefaults
boolean

When true and all variables are locked+filled, skip entry prompt

enabledMCPServers
string[]

Array of MCP server IDs enabled for this chat

mcpServerConfigs
object

Per-chat config overrides for MCP servers

Whether this chat is featured/promoted in the catalog

tags
string[]
defaultCompletionCriteria
string

ASSIGNMENT_COMPLETION_CRITERIA — default completion criteria for assignments

defaultMaxAttempts
integer
defaultAllowDelegation
boolean
defaultAllowRejection
boolean
isWorkspace
boolean

Server-only: true when request targets the ephemeral cross-chat workspace. Never persisted.