Struct AgentEndpoint 

pub struct AgentEndpoint<A> { /* private fields */ }

An agent plus the per-run settings it is served with.

route_agui mounts an agent with the defaults; build one of these and use route_agui_with when you want to change them.

use ag_ui::axum::{AgentEndpoint, RouterExt};
use ag_ui::server::FilterToolCalls;
use axum::Router;
use std::time::Duration;

let endpoint = AgentEndpoint::new(CartAgent)
    .transformer(|| FilterToolCalls::deny(["internal_debug"]))
    .keep_alive(Duration::from_secs(15));

let app: Router = Router::new().route_agui_with("/agent", endpoint);

Implementations

impl<A> AgentEndpoint<A>

pub fn new(agent: A) -> Self

Wraps an agent with the default settings.

pub fn transformer<F, T>(self, factory: F) -> Self

where F: Fn() -> T + Send + Sync + 'static, T: StreamTransformer + 'static,

Appends a transformer to every run’s chain.

Why a closure and not a transformer

A StreamTransformer takes &mut self because a useful one is a state machine — FilterToolCalls remembers which call ids it dropped. One instance shared across concurrent runs would leak one run’s state into another, so the endpoint stores the recipe and builds a fresh chain per request.

pub fn echo_input(self, echo: bool) -> Self

Echoes the request body back on RUN_STARTED.

See Runner::echo_input. Off by default — it is the largest payload in the protocol.

pub fn keep_alive(self, interval: Duration) -> Self

Sends an SSE comment whenever a run produces nothing for interval.

See SseResponse::keep_alive. Off by default.

Trait Implementations

impl<A> Debug for AgentEndpoint<A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Describes the settings, not the agent: an agent holds an LLM client and a database handle, and neither is Debug.