Skip to main content
PATCH
Rename or pin an AI Assistant thread

Authorizations

X-API-Key
string
header
required

Path Parameters

origin
enum<string>
required

Which store a thread lives in.

The four assistants keep their transcripts in four tables with four shapes, and nothing here moves them. An origin plus the thread's id in that store is how one row of the meta table names a thread, and how the dock knows which capability the thread carries when it is reopened.

Available options:
table,
find_leads,
agent,
chat
thread_id
string<uuid>
required

Body

application/json

Rename a thread, pin or unpin it, or both. A field left out is left alone.

pinned
boolean | null

True pins the thread to the top; false unpins.

title
string | null

The new title. Kept beside the store's own title rather than written into it, so the store keeps naming the thread after its first message and this is what the list shows instead.

Required string length: 1 - 255

Response

Successful Response

One thread in the list, from whichever assistant it belongs to.

continued_from
AssistantThreadRefSchema · object | null
required

The thread this one continues: the search that produced this table.

continued_in
AssistantThreadRefSchema · object | null
required

The thread this one continues in: the table this search produced.

created_at
string<date-time>
required
last_message_at
string<date-time> | null
required
open_path
string
required

Where the dashboard navigates to reopen the thread: the table with its assistant panel on this conversation, the lead search assistant, the agent editor, or the chat.

origin
enum<string>
required

Which store a thread lives in.

The four assistants keep their transcripts in four tables with four shapes, and nothing here moves them. An origin plus the thread's id in that store is how one row of the meta table names a thread, and how the dock knows which capability the thread carries when it is reopened.

Available options:
table,
find_leads,
agent,
chat
origin_ref_id
string<uuid> | null
required

The table or saved agent the thread is bound to; null for a lead search or the general chat.

origin_ref_label
string | null
required

That table's or agent's name, or what a lead search was for; null when the thread is bound to nothing, or its agent is gone.

pinned
boolean
required
shared
boolean
required

A legacy table thread nobody is recorded as starting, which the whole workspace sees and may rename, pin or delete.

thread_id
string<uuid>
required
title
string
required