Skip to content

Create a new chat thread

POST
/api/canvas/{deal_id}/chat/threads
curl --request POST \
--url https://example.com/api/canvas/example/chat/threads \
--header 'Authorization: Bearer <token>'

Create a new chat thread for a deal.

deal_id
required
Deal Id
string

Successful Response

Media type application/json
CreateThreadResponse

Response body for creating a thread.

object
thread_id
required
Thread Id
string
title
required
Title
string
deal_id
required
Deal Id
string
Example generated
{
"thread_id": "example",
"title": "example",
"deal_id": "example"
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}