Skip to main content
POST
Start a thread

Authorizations

x-cominty-token
string
header
required

A Cominty Platform API secret. A key created now starts with sk-cmt-. Send it as is, or as Bearer sk-cmt-..., with at most one Bearer prefix. A key created before the prefix existed has no sk-cmt- and still works.

Body

application/json
message
HumanMessage · object
required
options
StartChatOptions · object
required
name
string | null

Optional name for the new thread.

project_id
string | null

Optional project to file the thread under.

Response

Successful Response

id
string<uuid>
required
name
string
required
created_at
string<date-time>
required
live
boolean
required
starred
boolean
required
messages
MessageOut · object[]
required
inception
enum<string>
required
read-only
Available options:
conversational,
routine
project_id
string | null