Skip to main content

Agent.listWorkflows()

The .listWorkflows() method retrieves the workflows configured for an agent, resolving them if they're a function. These workflows enable the agent to execute complex, multi-step processes with defined execution paths.

Usage example
Direct link to Usage example

await agent.listWorkflows()

Parameters
Direct link to Parameters

options?:

{ requestContext?: RequestContext }
= {}
Optional configuration object containing request context.
{ requestContext?: RequestContext }

requestContext?:

RequestContext
Request Context for dependency injection and contextual information.

Returns
Direct link to Returns

workflows:

Promise<Record<string, Workflow>>
A promise that resolves to a record of workflow names to their corresponding Workflow instances.

Extended usage example
Direct link to Extended usage example

await agent.listWorkflows({
requestContext: new RequestContext(),
})
On this page