Chat with next-gen assistant

Prev Next
Post
/chats/v2

Chat with next-gen assistant

Security
API Key: Bearer
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
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
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
threadId
string | null
Responses
200

Success

Expand All
object
text
string | null
toolCalls
Array of object (ToolCall) | null
object
id
string
name
string
type
string
callId
string
arguments
string
reference
object (ReferenceChatv2)
referenceIds
Array of string | null
string
position
integer
sources
object (Sources)
sourcesIds
Array of string | null
string
tool
object (Tool)
toolCallStatus
object (ToolCallStatus)
toolCallId
string
status
string
Valid values[ "Start", "End", "Failed" ]
toolStep
object (ToolStep)
stepDescription
string
toolId
string
response
object (ToolResponse)
name
string
toolId
string
resources
object (ToolResources)
enterprise
object (EnterpriseToolResources)
results
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*
title
string | null
subtitle
string | null
url
string | null
webSearch
object (WebSearchToolResources)
sources
Array of object (WebSource) | null
object
id
string
url
string
icon
string
title
string
siteName
string
description
string
custom
object (CustomToolResources)
property*
requestId
string | null
Expand All
object
text
string | null
toolCalls
Array of object (ToolCall) | null
object
id
string
name
string
type
string
callId
string
arguments
string
reference
object (ReferenceChatv2)
referenceIds
Array of string | null
string
position
integer
sources
object (Sources)
sourcesIds
Array of string | null
string
tool
object (Tool)
toolCallStatus
object (ToolCallStatus)
toolCallId
string
status
string
Valid values[ "Start", "End", "Failed" ]
toolStep
object (ToolStep)
stepDescription
string
toolId
string
response
object (ToolResponse)
name
string
toolId
string
resources
object (ToolResources)
enterprise
object (EnterpriseToolResources)
results
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*
title
string | null
subtitle
string | null
url
string | null
webSearch
object (WebSearchToolResources)
sources
Array of object (WebSource) | null
object
id
string
url
string
icon
string
title
string
siteName
string
description
string
custom
object (CustomToolResources)
property*
requestId
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*