Introduction

The AI‑Driven API Gateway Built for the Next Generation — Intelligent, Scalable, and Optimized for Global Discovery

digiRunner APIM 4.5 Documentation

You are reading the documentation for digiRunner APIM version 4.5.

• Use the drop-down menu in the header to navigate to other versions.

Welcome to the digiRunner Documentation Center — your gateway to understanding, deploying, and mastering the next-generation API Gateway + AI Gateway platform.

As modern systems evolve toward AI-driven architectures, APIs have become more than just integration points — they are the foundation for security, scalability, automation, and now intelligent interaction. digiRunner helps you navigate this transformation with an open-source, UI-driven platform designed for mission-critical environments.

From API Gateway to AI Gateway

The digiRunner project has officially entered its next era. Building upon our robust API Gateway capabilities, we now introduce AI Gateway support, enabling developers and enterprises to:

• Seamlessly integrate AI models, LLM agents, and AI workflows using familiar API patterns

• Standardize access control and request governance for AI-related traffic

• Apply rate limits, authentication, routing rules, and auditing to both API and AI endpoints

• Manage multi-model environments with UI-based configuration

• Bring AI capabilities into existing API ecosystems without rewriting architecture

digiRunner now empowers teams not only to manage APIs, but also to operationalize AI safely, efficiently, and consistently.

What digiRunner Solves

APIs—and now AI endpoints—can quickly become difficult to govern. digiRunner tackles these challenges head‑on:

Challenge	Without digiRunner	With digiRunner
Endpoint Management	Scattered API and AI endpoints across teams	Centralized governance for APIs & AI models
Access Control	Manual token handling & inconsistent policies	Unified OAuth2/OIDC, RBAC, and API key management
Routing	Static routing configurations	Intelligent, non-blocking traffic dispatching
AI Usage Safety	Risky or unmonitored AI service consumption	Real-time monitoring dashboards with AI usage insights
Version & Workflow Management	Manual tracking, slow updates	Built-in version control and routing strategies
Onboarding & Learning Curve	Slow onboarding and steep learning curves	AI-assisted onboarding, documentation, and troubleshooting

Key Features (API + AI)

• AI Gateway Support – Manage AI endpoints with governance, routing, rate limiting, and access control.

• Intelligent Traffic Dispatching – Non-blocking request handling ensures availability even under high load.

• RBAC & Authentication – OAuth2/OIDC, API keys, and fine-grained role policies.

• Rate Limiting & Quotas – Protect APIs and AI endpoints with flexible throttling rules.

• Real-Time Monitoring – Track traffic, errors, and AI call behavior instantly.

• Easy Deployment – Local, Docker, or cloud-native environments, fully UI-driven.

• AI-Powered Documentation – Faster learning with intelligent search and contextual guidance.

Who Benefits?

Developers

• Faster development with UI-driven configs

• Debug smarter with AI-assisted documentation

DevOps / SREs

• Enforce consistent governance across all systems

• Monitor health, traffic, and AI usage in real time

Software Architects

• Design scalable API + AI architectures with centralized policies

• Ensure compliance and role-based access

Product Managers / Business Stakeholders

• Gain visibility into API and AI traffic trends

• Make informed decisions using actionable dashboards

What You Can Do Here (Documentation Center)

The digiRunner Documentation Center helps you:

• Onboard team members with tutorials and visual walkthroughs

• Configure API and AI endpoints with step-by-step guides

• Reduce errors with consistent, example-based configurations

• Explore best practices for governance and architecture

• Stay up-to-date with changelogs and searchable glossaries

---

Ready to Start?

• Configure your first AI endpoint (AI Provider).

• Deploy your first API Gateway today and simplify governance from Get Started.

• Use AI-powered search (Ask AI) to learn faster — you can even search in your preferred language, and the AI will respond in that language automatically

Explore the Documentation

Navigate digiRunner documentation by role and intent.

Use the cards below to quickly understand the structure of the documentation and jump directly to the section that matches your goals — whether you are evaluating the architecture, setting up your first API, integrating applications, or troubleshooting security issues.

Overview

Best for: Architects / PMs

Architecture and core concepts

Get a high-level understanding of how digiRunner works. This section explains the APIM architecture, core concepts, platform terminology (Glossary), and licensing model. It is the best starting point for architects and decision-makers who need a clear mental model before deployment.

APIM Architecture

Key Concepts

Glossary

Get Started

Best for: DevOps engineers / New users

Install and run your first API Gateway

A hands-on onboarding path for new users. Learn how to install digiRunner using Docker or Docker Compose, initialize database settings, and register your first API. This section also introduces sandbox testing and basic load balancing.

Installing digiRunner API Management

Registering Your First APIs with digiRunner

Load Balancing

Most Common Use Cases

Best for: System administrators / Operators

Task-oriented operational recipes

Step-by-step solutions for everyday operational tasks. Find guidance on obtaining API keys, configuring IP diversion strategies, viewing real-time logs, managing RBAC permissions, and integrating OIDC login.

Obtaining API Keys and Calling APIs

API IP Diversion

Requesting API Authorization with X-API-Key

GUIDE

Best for: Platform administrators / Operators

Platform administration and configuration

The central operations manual for digiRunner administrators. Learn how to use the Admin Console to manage users and clients, configure monitoring and alerts, manage certificates, and set up AI Gateway routing and policies.

API Key

AI Gateway

API Management

API Integration Guide

Best for: Frontend / Backend developers

Secure API integration for developers

Technical specifications for application developers integrating with digiRunner-managed APIs. This section covers OAuth 2.0 and OpenID Connect (OIDC) flows, token lifecycle management, X-API-Key usage, and JWS/JWE encryption.

Using X API Key for Authentication and Authorization

Using API Key for Authentication and Authorization

Using Token for Authentication and Authorization

API Management FAQ

Best for: Security teams / Support / SRE

Security and troubleshooting knowledge base

Answers to common security and operational issues. Learn how digiRunner protects against DoS attacks and SQL injection, and how to troubleshoot common errors such as 403 Forbidden or missing authorization codes.

DoS Prevention and Traffic Protection Mechanisms

SQL Injection Prevention Mechanism

Troubleshooting API Gateway & Identity Services