# Idun Engine

## Docs

- [Engine SDK](https://docs.idun-group.com/advanced/sdk.md): Drive Idun Engine directly from Python: boot the engine in-process, embed its FastAPI app into an existing service, or build configs programmatically with ConfigBuilder.
- [Check Memory Connection](https://docs.idun-group.com/api-reference/agent-configuration/check-memory-connection.md): Probe the configured memory backend.
- [Create From Detection](https://docs.idun-group.com/api-reference/agent-configuration/create-from-detection.md): Materialize a detection picked by the wizard.
- [Create Guardrail](https://docs.idun-group.com/api-reference/agent-configuration/create-guardrail.md): Create a new guardrail row.
- [Create Prompt](https://docs.idun-group.com/api-reference/agent-configuration/create-prompt.md): Create a new prompt version.
- [Create Starter](https://docs.idun-group.com/api-reference/agent-configuration/create-starter.md): Scaffold a starter project + register the singleton agent row.
- [Delete Guardrail](https://docs.idun-group.com/api-reference/agent-configuration/delete-guardrail.md): Remove a guardrail row.
- [Delete Memory](https://docs.idun-group.com/api-reference/agent-configuration/delete-memory.md): Remove the singleton memory row.
- [Delete Prompt](https://docs.idun-group.com/api-reference/agent-configuration/delete-prompt.md): Remove a single prompt version.
- [Get Agent](https://docs.idun-group.com/api-reference/agent-configuration/get-agent.md): Return the current singleton agent.
- [Get Guardrail](https://docs.idun-group.com/api-reference/agent-configuration/get-guardrail.md): Return a single guardrail row or 404.
- [Get Memory](https://docs.idun-group.com/api-reference/agent-configuration/get-memory.md): Return the singleton memory row or 404 if absent.
- [Get Prompt](https://docs.idun-group.com/api-reference/agent-configuration/get-prompt.md): Return a single prompt version row or 404.
- [List Guardrails](https://docs.idun-group.com/api-reference/agent-configuration/list-guardrails.md): Return all guardrail rows ordered by position then sort_order.
- [List Prompts](https://docs.idun-group.com/api-reference/agent-configuration/list-prompts.md): Return all prompt versions ordered by prompt id then version.
- [Patch Agent](https://docs.idun-group.com/api-reference/agent-configuration/patch-agent.md): Update metadata fields on the singleton agent.
- [Patch Guardrail](https://docs.idun-group.com/api-reference/agent-configuration/patch-guardrail.md): Apply a shallow update to an existing guardrail row.
- [Patch Memory](https://docs.idun-group.com/api-reference/agent-configuration/patch-memory.md): Upsert the singleton memory row.
- [Patch Prompt](https://docs.idun-group.com/api-reference/agent-configuration/patch-prompt.md): Update tags on an existing prompt version.
- [Scan](https://docs.idun-group.com/api-reference/agent-configuration/scan.md): Classify the project and return the scanner result.
- [Change Password](https://docs.idun-group.com/api-reference/auth-&-sso/change-password.md): Replace the admin password hash.
- [Delete Sso](https://docs.idun-group.com/api-reference/auth-&-sso/delete-sso.md)
- [Get Sso](https://docs.idun-group.com/api-reference/auth-&-sso/get-sso.md)
- [Login](https://docs.idun-group.com/api-reference/auth-&-sso/login.md): Verify the password and set the signed session cookie.
- [Logout](https://docs.idun-group.com/api-reference/auth-&-sso/logout.md): Drop the session row and clear the cookie.
- [Me](https://docs.idun-group.com/api-reference/auth-&-sso/me.md): Return the current auth state.
- [Patch Sso](https://docs.idun-group.com/api-reference/auth-&-sso/patch-sso.md)
- [Sso Info](https://docs.idun-group.com/api-reference/auth-&-sso/sso-info.md): Return the public OIDC parameters for the SPA, or ``enabled=false``.
- [Get Dashboard](https://docs.idun-group.com/api-reference/dashboard/get-dashboard.md): Return all five v1 dashboard widgets for the requested time range.
- [Create Integration](https://docs.idun-group.com/api-reference/integrations-&-tools/create-integration.md): Create a new integration row.
- [Create Mcp Server](https://docs.idun-group.com/api-reference/integrations-&-tools/create-mcp-server.md): Create a new MCP server row.
- [Delete Integration](https://docs.idun-group.com/api-reference/integrations-&-tools/delete-integration.md): Remove an integration row.
- [Delete Mcp Server](https://docs.idun-group.com/api-reference/integrations-&-tools/delete-mcp-server.md): Remove an MCP server row.
- [Get Integration](https://docs.idun-group.com/api-reference/integrations-&-tools/get-integration.md): Return a single integration row or 404.
- [Get Mcp Server](https://docs.idun-group.com/api-reference/integrations-&-tools/get-mcp-server.md): Return a single MCP server row or 404.
- [List Integrations](https://docs.idun-group.com/api-reference/integrations-&-tools/list-integrations.md): Return all configured integration rows ordered by created_at.
- [List Mcp Server Tools](https://docs.idun-group.com/api-reference/integrations-&-tools/list-mcp-server-tools.md): Discover tools exposed by a single MCP server.
- [List Mcp Servers](https://docs.idun-group.com/api-reference/integrations-&-tools/list-mcp-servers.md): Return all configured MCP server rows ordered by created_at.
- [Patch Integration](https://docs.idun-group.com/api-reference/integrations-&-tools/patch-integration.md): Apply a shallow update to an existing integration row.
- [Patch Mcp Server](https://docs.idun-group.com/api-reference/integrations-&-tools/patch-mcp-server.md): Apply a shallow update to an existing MCP server row.
- [Introduction](https://docs.idun-group.com/api-reference/introduction.md): HTTP API of every idun-agent-standalone deployment. 42 endpoints, rendered from a snapshot of the live FastAPI app's OpenAPI spec.
- [Invoke](https://docs.idun-group.com/api-reference/invoke.md): Invoke the agent with a message and get a response.
- [Check Observability Connection](https://docs.idun-group.com/api-reference/observability/check-observability-connection.md): Probe the configured observability provider.
- [Delete Observability](https://docs.idun-group.com/api-reference/observability/delete-observability.md): Remove the singleton observability row.
- [Get Observability](https://docs.idun-group.com/api-reference/observability/get-observability.md): Return the singleton observability row or 404 if absent.
- [Patch Observability](https://docs.idun-group.com/api-reference/observability/patch-observability.md): Upsert the singleton observability row.
- [Capabilities](https://docs.idun-group.com/api-reference/runtime/capabilities.md): Return the agent's capability descriptor for UI auto-configuration.
- [Copilotkit Stream](https://docs.idun-group.com/api-reference/runtime/copilotkit-stream.md): Process a message with the agent, streaming ag-ui events.
- [Engine Info](https://docs.idun-group.com/api-reference/runtime/engine-info.md): Engine info endpoint — basic information about the service.
- [Get Config](https://docs.idun-group.com/api-reference/runtime/get-config.md): Get the current agent configuration.
- [Get Graph Ascii](https://docs.idun-group.com/api-reference/runtime/get-graph-ascii.md): ASCII art rendering.
- [Get Graph Ir](https://docs.idun-group.com/api-reference/runtime/get-graph-ir.md): Framework-agnostic JSON IR — primary contract for UI rendering.
- [Get Graph Mermaid](https://docs.idun-group.com/api-reference/runtime/get-graph-mermaid.md): Mermaid source string.
- [Get Session](https://docs.idun-group.com/api-reference/runtime/get-session.md): Return a single session's reconstructed text-only message thread.
- [Health Check](https://docs.idun-group.com/api-reference/runtime/health-check.md): Health check endpoint for monitoring and load balancers.
- [List Sessions](https://docs.idun-group.com/api-reference/runtime/list-sessions.md): List session summaries from the active memory backend.
- [Reload Config](https://docs.idun-group.com/api-reference/runtime/reload-config.md): Reload the agent configuration from the manager or a file.
- [Run](https://docs.idun-group.com/api-reference/runtime/run.md): Canonical AG-UI interaction endpoint.
- [Runtime Config Js](https://docs.idun-group.com/api-reference/runtime/runtime-config-js.md): Return a tiny script that seeds ``window.__IDUN_CONFIG__``.
- [Stream](https://docs.idun-group.com/api-reference/runtime/stream.md): Process a message with the agent, streaming ag-ui events.
- [Bulk Delete Traces](https://docs.idun-group.com/api-reference/traces/bulk-delete-traces.md): Bulk-delete traces matching the same filters as ``GET ``.
- [Delete Trace](https://docs.idun-group.com/api-reference/traces/delete-trace.md): Delete a single trace and cascade to its spans.
- [Get Trace Detail](https://docs.idun-group.com/api-reference/traces/get-trace-detail.md): Return the trace + its span tree.
- [List Traces](https://docs.idun-group.com/api-reference/traces/list-traces.md): List traces sorted by ``started_at DESC`` with cursor pagination.
- [Trace Pipeline Health](https://docs.idun-group.com/api-reference/traces/trace-pipeline-health.md): Return queue depth + drop count from the running exporter.
- [Architecture](https://docs.idun-group.com/architecture.md): How idun-agent-engine and idun-agent-standalone connect to turn LangGraph or ADK agent code into a production FastAPI service.
- [Authentication](https://docs.idun-group.com/auth/overview.md): Admin-panel auth modes (`none` / `password`) and the environment variables that drive them.
- [SSO](https://docs.idun-group.com/auth/sso.md): Per-agent OIDC SSO that validates a JWT on every `/agent/*` request, with per-user allowlists by domain or email.
- [Changelog](https://docs.idun-group.com/changelog/overview.md): Latest updates and releases for Idun Engine.
- [CLI](https://docs.idun-group.com/cli/overview.md): The Idun CLI: one console script (idun) for serving the standalone, scaffolding a new project, hashing passwords, and running engine-only mode.
- [Configuration](https://docs.idun-group.com/configuration.md): Engine configuration reference for server settings, agent framework, observability, guardrails, memory, MCP, SSO, and integrations.
- [Production hardening](https://docs.idun-group.com/deployment/hardening.md): Production deployment checklist for the standalone server: bind address, admin auth, session secret, cookie security, TLS termination, secrets management, and trace retention.
- [Deployment](https://docs.idun-group.com/deployment/overview.md): Where to run the standalone in production. Cloud Run, Docker on any host, or engine-only mode for users with their own admin stack.
- [Audit logs](https://docs.idun-group.com/enterprise/audit-logs.md): Tamper-evident record of every admin write, who performed it, and when, across the agent fleet.
- [Multi-agent management](https://docs.idun-group.com/enterprise/multi-agent.md): Register, monitor, and update multiple Idun Engine standalones from a single control plane.
- [Enterprise](https://docs.idun-group.com/enterprise/overview.md): Run hundreds of agents on your own infrastructure with SSO, RBAC, audit logs, governance, and full data sovereignty.
- [RBAC](https://docs.idun-group.com/enterprise/rbac.md): Role-based access control across agents, configurations, and the admin surface.
- [Enterprise SSO](https://docs.idun-group.com/enterprise/sso.md): Wire Okta, Microsoft Entra ID, or any SAML / OIDC provider into every agent under one control plane.
- [FAQ](https://docs.idun-group.com/faq.md): Frequently asked questions about Idun Engine, covering frameworks, authentication, data storage, guardrails, and licensing.
- [Google ADK](https://docs.idun-group.com/frameworks/adk.md): Connect a Google ADK agent to Idun Engine with Gemini-powered workflows, session services, and memory backends.
- [Writing a custom framework adapter](https://docs.idun-group.com/frameworks/custom-adapter.md): Extend the engine to support a new agent framework by subclassing BaseAgent. Covers the abstract surface, lifecycle, capability discovery, history hooks, and the (currently hardcoded) factory registry.
- [LangGraph](https://docs.idun-group.com/frameworks/langgraph.md): Connect a LangGraph agent to Idun Engine with graph-based workflows, AG-UI streaming, and persistent checkpointing.
- [Agent frameworks](https://docs.idun-group.com/frameworks/overview.md): Connect LangGraph or Google ADK agents to Idun Engine and run them as production-ready services.
- [Glossary](https://docs.idun-group.com/glossary.md): Definitions of the Idun packages and where each one fits.
- [Guardrails](https://docs.idun-group.com/guardrails/overview.md): Protect your agents with 15 built-in guardrails for PII detection, jailbreak prevention, toxic language filtering, topic restriction, and more.
- [Guardrails reference](https://docs.idun-group.com/guardrails/reference.md): Reference for all 15 guardrail types available in Idun Engine, including configuration fields and usage positions.
- [Connect your existing agent](https://docs.idun-group.com/guides/connect-your-agent.md): Wrap an existing LangGraph or ADK agent in an Idun engine service. Write a minimal config.yaml that points at your StateGraph, install idun-agent-engine, and run.
- [How easy it is to use Idun Engine with any Deep Agent](https://docs.idun-group.com/guides/deepagents-with-idun.md): Wrap LangChain's Deep Agents framework in a production FastAPI service in minutes. Discover your agent through the Idun wizard, chat with it, get built-in dashboards and traces, plug in Langfuse on top, then add a Google Workspace MCP to send email — all without touching the engine code.
- [Build and run the idun-assistant copilot](https://docs.idun-group.com/guides/idun-assistant-copilot.md): Wire a LangGraph agent into Idun Engine end to end: MCP tools, system prompt, SQLite memory, Langfuse observability, and Google OIDC SSO, then run a multi-tool task in chat.
- [How to deploy a LangGraph agent to production in 5 minutes](https://docs.idun-group.com/guides/langgraph-production-deployment.md): Step-by-step tutorial to take a LangGraph agent from a local script to a production API with streaming, guardrails, memory, and observability using Idun Engine.
- [Guides](https://docs.idun-group.com/guides/overview.md): Step-by-step tutorials for common workflows on Idun Engine.
- [Programmatic chat: the /agent/run contract](https://docs.idun-group.com/guides/programmatic-chat.md): Drive your Idun-hosted agent from a script using the AG-UI request shape, plus the structured-mode trap to watch out for.
- [Discord](https://docs.idun-group.com/integrations/discord.md): Connect your Idun agent to Discord so users can interact with it through slash commands.
- [Google Chat](https://docs.idun-group.com/integrations/google-chat.md): Connect your Idun agent to Google Chat so users can interact with it by @mentioning the bot in spaces and direct messages.
- [Slack](https://docs.idun-group.com/integrations/slack.md): Connect your Idun agent to Slack so users can interact with it through direct messages and channel messages.
- [Microsoft Teams](https://docs.idun-group.com/integrations/teams.md): Connect your Idun agent to Microsoft Teams as a Bot Framework bot so users can @mention it in channels and direct messages.
- [WhatsApp](https://docs.idun-group.com/integrations/whatsapp.md): Connect your Idun agent to WhatsApp so users can interact with it through messages using the Meta Business API.
- [Introduction](https://docs.idun-group.com/introduction.md): Everything Idun Engine ships: agent runtime, chat UI, admin, traces, guardrails, memory, MCP, integrations, and auth, in one self-hosted process.
- [Docker MCP toolkit](https://docs.idun-group.com/mcp-servers/docker-toolkit.md): Add external tool capabilities to your agents using pre-built MCP servers from the Docker MCP toolkit.
- [MCP Servers](https://docs.idun-group.com/mcp-servers/overview.md): Extend your agent with external tool servers using the Model Context Protocol.
- [ADK memory](https://docs.idun-group.com/memory/adk.md): Configure session services and memory services for ADK agents to manage conversation state and long-term knowledge.
- [LangGraph memory](https://docs.idun-group.com/memory/langgraph.md): Configure checkpointing for LangGraph agents to persist conversation state across interactions.
- [Memory](https://docs.idun-group.com/memory/overview.md): Enable agents to maintain state and context across conversations using checkpointing and session services.
- [Arize Phoenix](https://docs.idun-group.com/observability/arize-phoenix.md): Set up Arize Phoenix observability to trace, evaluate, and troubleshoot your agents.
- [Writing a custom observability handler](https://docs.idun-group.com/observability/custom-handler.md): Extend the engine to support a new tracing or observability provider by subclassing ObservabilityHandlerBase. Covers the abstract surface, callback vs global instrumentation patterns, and the factory registry.
- [Google Cloud Logging](https://docs.idun-group.com/observability/gcp-logging.md): Set up Google Cloud Logging to capture structured logs from your agents.
- [Google Cloud Trace](https://docs.idun-group.com/observability/gcp-trace.md): Set up Google Cloud Trace to capture distributed traces and analyze agent latency.
- [Langfuse](https://docs.idun-group.com/observability/langfuse.md): Set up Langfuse observability to monitor, trace, and debug your agents in real time.
- [LangSmith](https://docs.idun-group.com/observability/langsmith.md): Set up LangSmith observability to debug, test, evaluate, and monitor your agents.
- [Observability](https://docs.idun-group.com/observability/overview.md): Monitor, trace, and debug your agents with built-in integrations for popular observability platforms.
- [Telemetry events](https://docs.idun-group.com/observability/telemetry-events.md): Canonical list of browser-side PostHog events emitted by the Idun standalone UI.
- [Local trace store](https://docs.idun-group.com/observability/traces.md): Use the standalone runtime's built-in trace store and admin UI to inspect every agent run, LLM call, tool invocation, and cost.
- [Prompts](https://docs.idun-group.com/prompts.md): Version, store, and render prompt templates with Jinja2 variables. Edit them from the admin panel or seed from YAML.
- [Quickstart](https://docs.idun-group.com/quickstart.md): Deploy your first AI agent with Idun in under 30 minutes, from pip install to live chat UI.
- [Roadmap](https://docs.idun-group.com/roadmap.md): Where Idun Engine is today and what we're building next.
- [Admin panel and reload pipeline](https://docs.idun-group.com/standalone/admin.md): How the standalone admin panel saves changes, validates them, and hot-reloads the running engine without a process restart.
- [Deploy to Cloud Run](https://docs.idun-group.com/standalone/cloud-run.md): Single-container deploy on Google Cloud Run with managed Postgres.
- [Customizing the chat UI](https://docs.idun-group.com/standalone/customizing-ui.md): Theme, layout, and full UI replacement.
- [Overview](https://docs.idun-group.com/standalone/overview.md): A self-sufficient single-agent deployment with embedded chat UI, admin panel, and traces viewer.
- [Agent templates](https://docs.idun-group.com/templates.md): Clone a runnable agent template to get started faster. Nine examples covering common LangGraph and ADK patterns.
- [Troubleshooting](https://docs.idun-group.com/troubleshooting.md): Diagnose common Idun runtime errors: agent_not_ready, boot engine layer skipped, graph load failures, reload-pipeline rollbacks, and validation errors.

## OpenAPI Specs

- [openapi](https://docs.idun-group.com/standalone/openapi.json)