Assistant chats

Get an assistant chat

A chat the user had with the assistant inside the Needle web app, to continue it elsewhere. When `handoff` is set, the assistant passed the task on: its `brief` holds the goal, the ids involved, what was already found, and what is left. Messages hold each turn’s text and the tools it called. Calls since the last user message keep their results; earlier ones do not. Only the user who had the chat can read it.

GET

/api/v1/assistant-chats/{assistantChatId}

Path parameters

assistantChatId

required

string · uuid

Assistant chat id

Response

200The chat.

assistantChat

object

id

string · uuid

title

string

createdAt

string · date-time

updatedAt

string · date-time

handoff

object | null

Set when the assistant passed the task on. Null when the chat was not handed off.

task

string

One line naming the task for the agent that picks this chat up.

brief

string

Everything the next agent needs to continue: the goal, the ids involved, what was already found, and what is left.

messages

object[]

requestId

string · uuid

Id of this request, for support and troubleshooting

Errors

  • 400: Bad request
  • 401: Unauthorized: missing or invalid API key
  • 403: Forbidden
  • 404: Not found
  • 422: Invalid request payload

Search docs

Search documentation, API reference, and MCP tools

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy