Skip to main content
POST
cURL
This endpoint creates a new thread. It allows you to initialize a conversation thread, optionally providing metadata to associate with it.

Headers

X-API-Key
string
required

Your Langtail API Key

Example:

"<LANGTAIL_API_KEY>"

Body

application/json
metadata
object

A set of key-value pairs that can be attached to the thread. This can be used to store additional information about the thread to facilitate filtering or organization.

Example:
createLog
object

A log object that can be passed to create an initial log for the thread.

Response

Successfully created thread

id
string
required

The unique identifier for the created thread.

createdAt
string<date-time>
required

The timestamp when the thread was created.

projectId
string
required

The ID of the project this thread belongs to.

metadata
object | null

The metadata associated with the thread, if provided.

deletedAt
string<date-time> | null

The timestamp when the thread was deleted, if applicable.

createLog
object | null

The log created by the first message that creates the thread.