Update a thread

Update a chat thread's title and/or metadata.

PATCH

https://truememory-api.mvstg.com/threads/{thread_id}

View as Markdown

Authorization

HTTPBearerHTTPrequired

Path parameters

thread_idstringrequired

Header parameters

x-app-idoptional
Application ID for scoping threads
One of the following:
string
null
}
X-On-Behalf-Ofoptional
One of the following:
string
null
}
X-External-User-Idoptional
One of the following:
string
null
}
X-App-Idoptional
One of the following:
string
null
}

Request bodyJSONrequired

titleoptional
New title for the thread.
One of the following:
string
null
}
metadataoptional
Arbitrary metadata dict for the thread (e.g. source, pageType, isPinned).
One of the following:
object
null
}

Returns

200

Successful Response

JSON

thread_idstringrequired
Thread ID (session_key).
agent_idstringrequired
Agent that handled this thread.
created_atstringrequired
When the thread was created (ISO 8601).
updated_atstringrequired
When the thread was last updated (ISO 8601).
app_idoptional
Application scope for this thread. None if unscoped.
One of the following:
string
null
}
titleoptional
Thread title derived from the first user message.
One of the following:
string
null
}
metadataoptional
Arbitrary metadata dict for the thread.
One of the following:
object
null
}

422

Validation Error

JSON

detailoptionalarray ofobject
- locarray ofrequired
  One of the following:
  string
  integer
- msgstringrequired
- typestringrequired
- inputoptionalunknown
- ctxoptionalobject
}

curl --request PATCH \ --url 'https://truememory-api.mvstg.com/threads/<thread_id>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "title": "My conversation about weather", "metadata": { "isPinned": false, "pageType": "whatsapp-dm", "source": "whatsapp" } } '

{ "thread_id": "847c6285-8fc9-4560-a83f-4e6285809254", "agent_id": "chatbot", "app_id": "vibrantly", "title": "What is the weather in Tokyo?", "metadata": { "isPinned": false, "source": "whatsapp" }, "created_at": "string", "updated_at": "string" }