Skip to main content

aiThreadsGetById

AiThread aiThreadsGetById(threadId)

GET /api/2.0/ai/threads/get-by-id

Get a chat thread

Returns one thread by its ID, without its messages - read those with GET api/2.0/ai/threads/read-messages. threadId is required and an unknown one answers 404, so the result is never an empty body. The answer carries the thread's title, its model binding and its last-edit date. This is a read-only operation and does not bump that date.

Parameters​

NameInTypeDescriptionNotes
threadIdqueryStringThe chat thread identifier.[required] [example: 11111111-1111-1111-1111-111111111111]

Responses​

Status codeDescriptionTypeResponse headers
200The thread, without its messages.AiThread-
400threadId is missing.AiErrorResponse-
401Missing asc_auth_key cookie or Authorization header.AiErrorResponse-
403AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API.AiErrorResponse-
404No thread has this ID.AiErrorResponse-
500Unhandled failure. The reason is logged server-side and never echoed back.AiErrorResponse-

Return type​

AiThread

Authorization​

cookieAuth, bearerAuth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json