Skip to content

docs: sync Haystack API reference on Docusaurus #12091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Jul 21, 2026
Merged

docs: sync Haystack API reference on Docusaurus #12091

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs-website/reference/haystack-api/agents_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,10 @@ Process messages and execute tools until an exit condition is met.
- "token_usage": Aggregated token usage from every LLM call in the run, summed from each LLM message's
`meta["usage"]`.
- "tool_call_counts": Mapping of tool name to the number of times that tool was invoked.
- "exit_reason": Why the Agent stopped, useful for routing the output downstream (e.g. with a
`ConditionalRouter`). One of: `"text"` (the model returned a reply with no tool calls), the name of
the tool that satisfied a tool exit condition (in which case `last_message` is that tool's result),
or `"max_agent_steps"` (the Agent hit `max_agent_steps` before meeting an exit condition).
- Any additional keys defined in the `state_schema`.

#### run_async
Expand Down Expand Up @@ -399,6 +403,10 @@ if available.
- "token_usage": Aggregated token usage from every LLM call in the run, summed from each LLM message's
`meta["usage"]`.
- "tool_call_counts": Mapping of tool name to the number of times that tool was invoked.
- "exit_reason": Why the Agent stopped, useful for routing the output downstream (e.g. with a
`ConditionalRouter`). One of: `"text"` (the model returned a reply with no tool calls), the name of
the tool that satisfied a tool exit condition (in which case `last_message` is that tool's result),
or `"max_agent_steps"` (the Agent hit `max_agent_steps` before meeting an exit condition).
- Any additional keys defined in the `state_schema`.

## state/state
Expand Down