Chat with assistant
  • 07 Mar 2025
  • 6 Minutes to read
  • Contributors
  • Dark
    Light

Chat with assistant

  • Dark
    Light

Article summary

Post
/chats

Chat with any assistant

Security
API Key
Header parameter nameAuthorization

Enter the token with the Bearer: prefix, e.g. "Bearer abcde12345".

Header parameters
unleash-account

Email address of the user to impersonate. This header allows the caller to perform actions on behalf of the specified user.

Body parameters
Expand All
object
messages
Array of object (ChatMessageRequest) Required
Min items1
object
text
string | null
role
string
Valid values[ "User", "System", "Assistant" ]
assistantId
string | null
enterpriseSearch
object (ChatEnterpriseSearchRequest)
filters
object (SearchFilters)
resourceId
Array of string | null
string
isStarred
boolean | null
hasAttachments
boolean | null
rsvp
Array of string | null
string
appId
Array of string | null
string
type
Array of string | null
string
label
Array of string | null
string
anyLabel
Array of string | null
string
sentTo
Array of string | null
string
sentFrom
Array of string | null
string
createdBy
Array of string | null
string
modifiedBy
Array of string | null
string
reporter
Array of string | null
string
assignedTo
Array of string | null
string
reviewer
Array of string | null
string
fromTime
string | null
untilTime
string | null
createBeforeTime
string | null
createAfterTime
string | null
modifiedBeforeTime
string | null
modifiedAfterTime
string | null
dueBeforeTime
string | null
dueAfterTime
string | null
class
Array of string | null
string
sharedBy
Array of string | null
string
sharedWith
Array of string | null
string
linkId
Array of string | null
string
eventTimeFrameStart
string | null
eventTimeFrameEnd
string | null
status
Array of string | null
string
cycle
Array of string | null
string
extension
Array of string | null
string
jobTitle
Array of string | null
string
location
Array of string | null
string
department
Array of string | null
string
managedBy
Array of string | null
string
isManager
boolean | null
participants
Array of string | null
string
topic
Array of string | null
string
hasLinks
boolean | null
mentioned
Array of string | null
string
pathPrefix
Array of string | null
string
path
Array of string | null
string
fileTypeGroup
Array of string | null
string
relatedContacts
Array of string | null
string
recentActivityFor
string | null
workingOn
string | null
property*
stream
boolean
threadId
string | null
Expand All
object
messages
Array of object (ChatMessageRequest) Required
Min items1
object
text
string | null
role
string
Valid values[ "User", "System", "Assistant" ]
assistantId
string | null
enterpriseSearch
object (ChatEnterpriseSearchRequest)
filters
object (SearchFilters)
resourceId
Array of string | null
string
isStarred
boolean | null
hasAttachments
boolean | null
rsvp
Array of string | null
string
appId
Array of string | null
string
type
Array of string | null
string
label
Array of string | null
string
anyLabel
Array of string | null
string
sentTo
Array of string | null
string
sentFrom
Array of string | null
string
createdBy
Array of string | null
string
modifiedBy
Array of string | null
string
reporter
Array of string | null
string
assignedTo
Array of string | null
string
reviewer
Array of string | null
string
fromTime
string | null
untilTime
string | null
createBeforeTime
string | null
createAfterTime
string | null
modifiedBeforeTime
string | null
modifiedAfterTime
string | null
dueBeforeTime
string | null
dueAfterTime
string | null
class
Array of string | null
string
sharedBy
Array of string | null
string
sharedWith
Array of string | null
string
linkId
Array of string | null
string
eventTimeFrameStart
string | null
eventTimeFrameEnd
string | null
status
Array of string | null
string
cycle
Array of string | null
string
extension
Array of string | null
string
jobTitle
Array of string | null
string
location
Array of string | null
string
department
Array of string | null
string
managedBy
Array of string | null
string
isManager
boolean | null
participants
Array of string | null
string
topic
Array of string | null
string
hasLinks
boolean | null
mentioned
Array of string | null
string
pathPrefix
Array of string | null
string
path
Array of string | null
string
fileTypeGroup
Array of string | null
string
relatedContacts
Array of string | null
string
recentActivityFor
string | null
workingOn
string | null
property*
stream
boolean
threadId
string | null
Expand All
object
messages
Array of object (ChatMessageRequest) Required
Min items1
object
text
string | null
role
string
Valid values[ "User", "System", "Assistant" ]
assistantId
string | null
enterpriseSearch
object (ChatEnterpriseSearchRequest)
filters
object (SearchFilters)
resourceId
Array of string | null
string
isStarred
boolean | null
hasAttachments
boolean | null
rsvp
Array of string | null
string
appId
Array of string | null
string
type
Array of string | null
string
label
Array of string | null
string
anyLabel
Array of string | null
string
sentTo
Array of string | null
string
sentFrom
Array of string | null
string
createdBy
Array of string | null
string
modifiedBy
Array of string | null
string
reporter
Array of string | null
string
assignedTo
Array of string | null
string
reviewer
Array of string | null
string
fromTime
string | null
untilTime
string | null
createBeforeTime
string | null
createAfterTime
string | null
modifiedBeforeTime
string | null
modifiedAfterTime
string | null
dueBeforeTime
string | null
dueAfterTime
string | null
class
Array of string | null
string
sharedBy
Array of string | null
string
sharedWith
Array of string | null
string
linkId
Array of string | null
string
eventTimeFrameStart
string | null
eventTimeFrameEnd
string | null
status
Array of string | null
string
cycle
Array of string | null
string
extension
Array of string | null
string
jobTitle
Array of string | null
string
location
Array of string | null
string
department
Array of string | null
string
managedBy
Array of string | null
string
isManager
boolean | null
participants
Array of string | null
string
topic
Array of string | null
string
hasLinks
boolean | null
mentioned
Array of string | null
string
pathPrefix
Array of string | null
string
path
Array of string | null
string
fileTypeGroup
Array of string | null
string
relatedContacts
Array of string | null
string
recentActivityFor
string | null
workingOn
string | null
property*
stream
boolean
threadId
string | null
Responses
200

Success

Expand All
object
type
string
Valid values[ "Request", "Resources", "Message", "References", "Progress", "Full" ]
requestId
string | null
message
object (ChatMessageResponse)
role
string
Valid values[ "User", "System", "Assistant" ]
parts
Array of object (IChatMessagePart) | null
object
type
string
Valid values[ "Text", "InlineReference" ]
resources
Array of object (Resource) | null
object
id
string | null
appId
string | null
type
string | null
externalId
string | null
name
string | null
data
object | null
property*
references
Array of object (Reference) | null
object
resourceId
string | null
threadId
string | null
Expand All
object
type
string
Valid values[ "Request", "Resources", "Message", "References", "Progress", "Full" ]
requestId
string | null
message
object (ChatMessageResponse)
role
string
Valid values[ "User", "System", "Assistant" ]
parts
Array of object (IChatMessagePart) | null
object
type
string
Valid values[ "Text", "InlineReference" ]
resources
Array of object (Resource) | null
object
id
string | null
appId
string | null
type
string | null
externalId
string | null
name
string | null
data
object | null
property*
references
Array of object (Reference) | null
object
resourceId
string | null
threadId
string | null
Expand All
object
type
string
Valid values[ "Request", "Resources", "Message", "References", "Progress", "Full" ]
requestId
string | null
message
object (ChatMessageResponse)
role
string
Valid values[ "User", "System", "Assistant" ]
parts
Array of object (IChatMessagePart) | null
object
type
string
Valid values[ "Text", "InlineReference" ]
resources
Array of object (Resource) | null
object
id
string | null
appId
string | null
type
string | null
externalId
string | null
name
string | null
data
object | null
property*
references
Array of object (Reference) | null
object
resourceId
string | null
threadId
string | null
400

Bad Request

Expand All
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
errors
object | null
property*
Array of string additionalProperties
string
property*
Expand All
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
errors
object | null
property*
Array of string additionalProperties
string
property*
Expand All
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
errors
object | null
property*
Array of string additionalProperties
string
property*

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.