Would like to understand more how forwardedProps should be used

[pedelman]

Hello, I have recently been exploring ag-ui and I noticed forwardedProps in the docs.

https://docs.ag-ui.com/sdk/js/core/types#runagentinput

type RunAgentInput = {
  threadId: string
  runId: string
  parentRunId?: string
  state: any
  messages: Message[]
  tools: Tool[]
  context: Context[]
  forwardedProps: any
}

I didn't find much information on how this is intended to be used. Is this just an open field to pass anything we want to the agent for custom implementation?

[NathanTarbert]

Hey @pedelman

I didn't find much information on how this is intended to be used. Is this just an open field to pass anything we want to the agent for custom implementation?

You're right - forwardedProps is an open field for sending any additional context your agent implementation might need at runtime. It’s not consumed by AG-UI itself, it simply forwards those props through the call chain so your custom logic or middleware can access them.

Something like:

agent.runAgent({forwardedProps: {authToken: "xyz"}, ...otherProperties});