Skip to main content
PATCH
/
api
/
v3
/
threads
/
{id}
Update a conversation thread
curl --request PATCH \
  --url https://paradigm.lighton.ai/api/v3/threads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ml_model": "<string>",
  "is_archived": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "running",
  "ml_model": "<string>",
  "ml_model_name": "<string>",
  "chat_setting": 123,
  "creation_source": "api",
  "is_read": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_ephemeral": true,
  "is_archived": true,
  "object": "thread"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
anonymize
boolean

Set to true to anonymize an ephemeral thread

​
cancel
boolean

Set to true to cancel the current turn processing

Body

​
name
string
Maximum string length: 255
​
ml_model
string
​
is_archived
boolean

Response

200 - application/json

Thread updated successfully or action performed

​
id
string<uuid>
required
​
name
string
required
​
status
enum<string>
required
  • running - Running
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
  • cancelling - Cancelling
Available options:
running,
completed,
failed,
cancelled,
cancelling
​
ml_model
string | null
required
​
ml_model_name
string | null
required
​
chat_setting
integer | null
required
​
creation_source
enum<string>
required

Indicates how the thread was created (API or UI).

  • api - API
  • web - WEB
Available options:
api,
web
​
is_read
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
is_ephemeral
boolean
required
​
is_archived
boolean
required
​
object
string
default:thread