CopilotKit

Loading Agent State

Learn how threadId is used to load previous agent states.


Setting the threadId#

When setting the threadId property in CopilotKit, i.e:

<CopilotKit threadId="2140b272-7180-410d-9526-f66210918b13">
  <YourApp />
</CopilotKit>

CopilotKit will restore the complete state of the thread, including the messages, from the database. (See Message Persistence for more details.)

Loading Agent State#

Important: For agent state to be loaded correctly, you must first ensure that message history and persistence are properly configured. Follow the guides on Threads & Persistence and Message Persistence.

This means that the state of any agent will also be restored. For example:

const { state } = useAgent({ agentId: "research_agent" });

// state will now be the state of research_agent in the thread id given above

Learn More#

To learn more about persistence and state in CopilotKit, see: