ADPeekUI API Reference: Methods, Properties, and Events

Written by

in

How to Integrate ADPeekUI Into Your Existing Workflow Integrating ADPeekUIβ€”the visual user-interface component powered by the AG-UI (Agent-User Interaction) Protocol and the Google Agent Development Kit (ADK)β€”is the fastest way to add real-time, interactive AI capabilities to your development stacks. By bringing standard AG-UI user interfaces into your backend systems, you shift from static automation to human-in-the-loop, collaborative AI workflows without modifying your core enterprise logic.

This technical guide covers how to orchestrate, install, and cleanly embed ADPeekUI into your current platform infrastructure. πŸ“‹ Prerequisites & Architecture Overview

Before writing code, ensure your environment supports the necessary streaming protocols. ADPeekUI operates on an event-driven loop that feeds standard Server-Sent Events (SSE) back to the browser or client application.

[ Your Frontend UI ] <— (AG-UI / SSE Events) —> [ ADPeekUI Gateway ] <—> [ ADK Agent Platform ]

Backend Engine: A Python or TypeScript runtime running an orchestration framework like Google ADK or Pydantic AI.

Transport Protocol: Support for bi-directional event streaming and execution state updates.

Access Tokens: Active API keys for underlying foundational LLMs (such as Google Gemini). πŸ”§ Step-by-Step Integration Guide 1. Initialize the Project Infrastructure

To establish an application capable of feeding real-time context to ADPeekUI, configure your project and install the ag-ui-adk package ecosystem using your package manager:

# Initialize your project environment uv init atlas –app cd atlas # Install necessary AG-UI and Google ADK dependencies uv add ag-ui-adk google-adk google-genai Use code with caution. 2. Define the Agent Logic Backend

Create an agent structure within your workspace to format incoming telemetry into data types that ADPeekUI can interpret. Create a dedicated runtime file (agents/atlas_agent/agent.py):

from pydantic_ai import Agent from ag_ui_adk import AgUiBridge # Initialize an agent capable of structured outputs agent = Agent( ‘google:gemini-2.5-flash’, deps_type=dict, result_type=str, system_prompt=“You are an automated enterprise workflow assistant.” ) # Bridge the agent runtime logic to stream UI events ui_bridge = AgUiBridge(agent=agent) Use code with caution. 3. Mount ADPeekUI on the Frontend

Leverage frontend kits like CopilotKit or standard React wrappers to expose the ADPeekUI canvas inside your user dashboard. Bootstrap the frontend framework with an ADK layout hook:

# Spin up an AG-UI matched interface template npx copilotkit@latest create -f adk export GOOGLE_API_KEY=“your-api-key” npm install && npm run dev Use code with caution.

In your application code, embed the layout component to instantly map your backend’s state updates directly to your screen: javascript

import { ADPeekUIProvider, AgentCanvas } from ‘@ag-ui/react’; export default function AppWorkflow() { return (

{/ADPeekUI loads the dynamic canvas right into your current dashboard */}

); } Use code with caution. πŸ“Š Comparing Workflow Architectures

When integrating ADPeekUI, pick an architectural pattern matching your operational needs:

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *