Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions docs/COMPATIBILITY_MATRIX.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This document maps platform versions to minimum SDK versions and the features ea

| Platform Version | Min SDK Version | Recommended SDK | Key Features Added |
|-----------------|----------------|-----------------|-------------------|
| v6.0.0 | v5.0.0 (Go/TS/Java), v6.0.0 (Python) | v5.0.0 / v6.0.0 | OAuth2 Basic auth required, legacy engine removed, agent single entry point, Go module v5 |
| v5.0.0 | v4.0.0 | v4.1.0 | Removed `total_steps` from create workflow, MCP operation default `"execute"`, Go module v4 |
| v4.8.0 | v3.8.0 | v3.8.0 | Version discovery, capability registry, User-Agent headers |
| v4.7.0 | v3.7.0 | v3.7.0 | MCP check-input/check-output endpoints, circuit breaker pipeline |
Expand Down
2 changes: 1 addition & 1 deletion docs/RBI_FREE_AI_COMPLIANCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RBI FREE-AI Framework Compliance Guide

*Last updated: March 2026 | AxonFlow Platform v5.4.2 | SDKs: Python v5.4.0, Go v4.3.0, TypeScript v4.3.1, Java v4.3.0*
*Last updated: April 2026 | AxonFlow Platform v6.0.0 | SDKs: Python v6.0.0, Go v5.0.0, TypeScript v5.0.0, Java v5.0.0*

This guide covers AxonFlow's compliance features for the Reserve Bank of India (RBI) Framework for Responsible and Ethical Enablement of AI (FREE-AI) published in August 2025.

Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AxonFlow Documentation

**Last Updated: March 2026** | **Platform: v5.4.2** | **SDKs: Python v5.4.0, Go v4.3.0, TypeScript v4.3.1, Java v4.3.0**
**Last Updated: April 2026** | **Platform: v6.0.0** | **SDKs: Python v6.0.0, Go v5.0.0, TypeScript v5.0.0, Java v5.0.0**

Public documentation for AxonFlow - synced to the Community Edition repository.

Expand Down Expand Up @@ -31,7 +31,7 @@ Configuration and how-to guides for common tasks.

## SDK Documentation

AxonFlow provides official SDKs for Go, Python, Java, and TypeScript. SDK versions: Python v5.3.0, Go/TypeScript/Java v4.3.0.
AxonFlow provides official SDKs for Go, Python, Java, and TypeScript. SDK versions: Python v6.0.0, Go/TypeScript/Java v5.0.0.

| Document | Description |
|----------|-------------|
Expand All @@ -41,7 +41,7 @@ AxonFlow provides official SDKs for Go, Python, Java, and TypeScript. SDK versio
### Go SDK

- **Repository:** [github.com/getaxonflow/axonflow-sdk-go](https://github.com/getaxonflow/axonflow-sdk-go)
- **Install:** `go get github.com/getaxonflow/axonflow-sdk-go/v4`
- **Install:** `go get github.com/getaxonflow/axonflow-sdk-go/v5`

### Python SDK

Expand Down
4 changes: 2 additions & 2 deletions docs/compliance/eu-ai-act.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EU AI Act Compliance Guide

*Last updated: March 2026 | AxonFlow Platform v5.4.2 | SDKs: Python v5.4.0, Go v4.3.0, TypeScript v4.3.1, Java v4.3.0*
*Last updated: April 2026 | AxonFlow Platform v6.0.0 | SDKs: Python v6.0.0, Go v5.0.0, TypeScript v5.0.0, Java v5.0.0*

AxonFlow provides comprehensive support for EU AI Act compliance. This guide covers the key features and APIs available for organizations operating AI systems in the European Union.

Expand Down Expand Up @@ -479,7 +479,7 @@ Proxy LLM calls through AxonFlow with EU AI Act compliance policies applied auto
**Go:**

```go
import "github.com/getaxonflow/axonflow-sdk-go/v4/axonflow"
import "github.com/getaxonflow/axonflow-sdk-go/v5/axonflow"

client := axonflow.NewClient(axonflow.AxonFlowConfig{
Endpoint: "https://your-axonflow-host",
Expand Down
4 changes: 2 additions & 2 deletions docs/compliance/rbi-free-ai.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RBI FREE-AI Framework Compliance

*Last updated: March 2026 | AxonFlow Platform v5.4.2 | SDKs: Python v5.4.0, Go v4.3.0, TypeScript v4.3.1, Java v4.3.0*
*Last updated: April 2026 | AxonFlow Platform v6.0.0 | SDKs: Python v6.0.0, Go v5.0.0, TypeScript v5.0.0, Java v5.0.0*

AxonFlow provides comprehensive compliance support for the Reserve Bank of India's **Framework for Responsible and Ethical Enablement of AI (FREE-AI)** guidelines for Indian banking institutions.

Expand Down Expand Up @@ -113,7 +113,7 @@ curl -X POST "https://your-axonflow-host/api/v1/query/execute" \
**Go:**

```go
import "github.com/getaxonflow/axonflow-sdk-go/v4/axonflow"
import "github.com/getaxonflow/axonflow-sdk-go/v5/axonflow"

client := axonflow.NewClient(axonflow.AxonFlowConfig{
Endpoint: "https://your-axonflow-host",
Expand Down
4 changes: 2 additions & 2 deletions docs/compliance/sebi-ai-ml.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SEBI AI/ML Guidelines Compliance

*Last updated: March 2026 | AxonFlow Platform v5.4.2 | SDKs: Python v5.4.0, Go v4.3.0, TypeScript v4.3.1, Java v4.3.0*
*Last updated: April 2026 | AxonFlow Platform v6.0.0 | SDKs: Python v6.0.0, Go v5.0.0, TypeScript v5.0.0, Java v5.0.0*

AxonFlow provides compliance support for the Securities and Exchange Board of India's **Framework for AI/ML in Securities Markets** for regulated entities in India's capital markets.

Expand Down Expand Up @@ -133,7 +133,7 @@ curl -X POST "https://your-axonflow-host/api/v1/query/execute" \
**Go:**

```go
import "github.com/getaxonflow/axonflow-sdk-go/v4/axonflow"
import "github.com/getaxonflow/axonflow-sdk-go/v5/axonflow"

client := axonflow.NewClient(axonflow.AxonFlowConfig{
Endpoint: "https://your-axonflow-host",
Expand Down
4 changes: 2 additions & 2 deletions docs/compliance/sebi-compliance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> **Comprehensive reference:** For the full SEBI AI/ML framework mapping including API endpoints, policy templates, and audit export workflows, see [sebi-ai-ml.md](./sebi-ai-ml.md). This document focuses on Indian PII detection details and hands-on implementation examples.

*Last updated: March 2026 | AxonFlow Platform v5.4.2 | SDKs: Python v5.4.0, Go v4.3.0, TypeScript v4.3.1, Java v4.3.0*
*Last updated: April 2026 | AxonFlow Platform v6.0.0 | SDKs: Python v6.0.0, Go v5.0.0, TypeScript v5.0.0, Java v5.0.0*

This guide covers AxonFlow's compliance features for the Securities and Exchange Board of India (SEBI) AI/ML Guidelines (June 2025 Consultation Paper) and the Digital Personal Data Protection Act (DPDP) 2023.

Expand Down Expand Up @@ -325,7 +325,7 @@ curl -X POST "https://your-axonflow-host/api/v1/query/execute" \
**Go:**

```go
import "github.com/getaxonflow/axonflow-sdk-go/v4/axonflow"
import "github.com/getaxonflow/axonflow-sdk-go/v5/axonflow"

client := axonflow.NewClient(axonflow.AxonFlowConfig{
Endpoint: "https://your-axonflow-host",
Expand Down
4 changes: 2 additions & 2 deletions docs/enterprise/approval-dashboard.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Approval Dashboard (Customer Portal)

**Last Updated:** March 2026
**Last Updated:** April 2026

**Platform Version:** v5.0.0 | **SDK Version:** v4.1.0
**Platform Version:** v5.0.0 | **SDK Version:** v5.0.0

The Approval Dashboard provides a human-in-the-loop (HITL) approval queue for workflow steps that require manual review before proceeding. It displays pending approvals with full policy context, enables approve/reject actions with mandatory justification, and supports real-time queue management.

Expand Down
4 changes: 2 additions & 2 deletions docs/enterprise/execution-timeline.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Execution Timeline (Customer Portal)

**Last Updated:** March 2026
**Last Updated:** April 2026

**Platform Version:** v5.0.0 | **SDK Version:** v4.1.0
**Platform Version:** v5.0.0 | **SDK Version:** v5.0.0

The Execution Timeline page provides enterprise customers with a centralized view of all MAP plan and WCP workflow executions. It surfaces real-time status, step-level timelines, policy gate decisions, LLM usage details, and per-step cost tracking directly within the Customer Portal.

Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started with AxonFlow

**Last Updated: March 2026** | **Platform: v5.4.2** | **SDKs: Python v5.4.0, Go v4.3.0, TypeScript v4.3.1, Java v4.3.0**
**Last Updated: April 2026** | **Platform: v6.0.0** | **SDKs: Python v6.0.0, Go v5.0.0, TypeScript v5.0.0, Java v5.0.0**

**Get AxonFlow running locally in about 10 minutes.**

Expand Down Expand Up @@ -177,7 +177,7 @@ Choose your language:

**Go:**
```bash
go get github.com/getaxonflow/axonflow-sdk-go/v4
go get github.com/getaxonflow/axonflow-sdk-go/v5
```

**Python:**
Expand All @@ -201,7 +201,7 @@ npm install @axonflow/sdk

### Step 3: Write Your First Agent (3 minutes)

Choose your language below. All four SDKs are fully supported at v4.2.0.
Choose your language below. All four SDKs are fully supported at v5.0.0.

#### Go

Expand All @@ -216,7 +216,7 @@ import (
"log"
"os"

axonflow "github.com/getaxonflow/axonflow-sdk-go/v4"
axonflow "github.com/getaxonflow/axonflow-sdk-go/v5"
)

func main() {
Expand Down Expand Up @@ -842,5 +842,5 @@ You've built your first AI agent with AxonFlow! Here's what to explore next:

---

*Last Updated: March 2026*
*Platform Version: v5.0.0 | SDK Version: v4.2.0*
*Last Updated: April 2026*
*Platform Version: v5.0.0 | SDK Version:** v5.0.0*
2 changes: 1 addition & 1 deletion docs/guides/choosing-a-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**Platform Version:** v5.0.0 | **SDKs:** v4.1.0
**Platform Version:** v6.0.0 | **SDKs:** v5.0.0

AxonFlow offers three integration modes to fit different requirements. This guide helps you choose the right one for your application.

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/execution-tracking.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Unified Execution Tracking

**Last Updated:** March 2026
**Last Updated:** April 2026

**Platform Version:** v5.0.0 | **SDK Version:** v4.1.0
**Platform Version:** v5.0.0 | **SDK Version:** v5.0.0

Unified Execution Tracking provides a consistent way to monitor and track the status of both MAP (Multi-Agent Planning) plans and WCP (Workflow Control Plane) workflows. This enables real-time progress monitoring, duration tracking, and cost analytics across all AxonFlow execution types.

Expand Down Expand Up @@ -233,7 +233,7 @@ import (
"os"
"time"

"github.com/getaxonflow/axonflow-sdk-go/v4"
"github.com/getaxonflow/axonflow-sdk-go/v5"
)

func main() {
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/execution-viewer.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Execution Viewer

**Last Updated:** March 2026
**Last Updated:** April 2026

**Platform Version:** v5.0.0 | **SDK Version:** v4.1.0
**Platform Version:** v5.0.0 | **SDK Version:** v5.0.0

AxonFlow provides multiple interfaces for inspecting workflow executions: the `axonctl` CLI, an embedded web UI, the REST API (via curl or SDK), and SDK clients in Go, Python, TypeScript, and Java.

Expand Down Expand Up @@ -264,7 +264,7 @@ import (
"fmt"
"os"

"github.com/getaxonflow/axonflow-sdk-go/v4"
"github.com/getaxonflow/axonflow-sdk-go/v5"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/gateway-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ sequenceDiagram

**Go:**
```go
import "github.com/getaxonflow/axonflow-sdk-go/v4"
import "github.com/getaxonflow/axonflow-sdk-go/v5"
```

**TypeScript:**
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/llm-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

**Last Updated:** February 2026

**Platform Version:** v5.0.0 | **SDK Version:** v4.1.0
**Platform Version:** v5.0.0 | **SDK Version:** v5.0.0

## Overview

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/mcp-audit-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**Platform Version:** v5.0.0 | **SDK Version:** v4.1.0
**Platform Version:** v5.0.0 | **SDK Version:** v5.0.0

This guide covers audit logging specific to MCP (Model Context Protocol) connector operations. For general audit logging (LLM proxy calls, policy evaluations), see [Audit Logging](./audit-logging.md). Every MCP query and execute operation is automatically logged to provide a complete audit trail for compliance and security analysis.

Expand Down Expand Up @@ -161,7 +161,7 @@ The SDK's `ConnectorResponse` includes `PolicyInfo` that matches the audit entry
### Go

```go
import "github.com/getaxonflow/axonflow-sdk-go/v4"
import "github.com/getaxonflow/axonflow-sdk-go/v5"

client := axonflow.NewClient(axonflow.AxonFlowConfig{
Endpoint: os.Getenv("AXONFLOW_ENDPOINT"),
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/proxy-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**Platform Version:** v5.0.0 | **SDK Version:** v4.1.0
**Platform Version:** v5.0.0 | **SDK Version:** v5.0.0

Proxy Mode is the simplest way to add governance to your AI applications. AxonFlow acts as a proxy between your application and LLM providers, handling policy enforcement, PII detection, rate limiting, and audit logging automatically.

Expand Down Expand Up @@ -71,7 +71,7 @@ const response = await axonflow.protect(async () => {
```go
import (
"os"
"github.com/getaxonflow/axonflow-sdk-go/v4"
"github.com/getaxonflow/axonflow-sdk-go/v5"
)

client := axonflow.NewClient(axonflow.AxonFlowConfig{
Expand Down
2 changes: 1 addition & 1 deletion docs/llm/azure-openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**Platform Version:** v5.0.0 | **SDKs:** v4.1.0
**Platform Version:** v6.0.0 | **SDKs:** v5.0.0

AxonFlow supports Azure OpenAI Service as a Community LLM provider, available without an enterprise license.

Expand Down
2 changes: 1 addition & 1 deletion docs/llm/gemini.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**Platform Version:** v5.0.0 | **SDKs:** v4.1.0
**Platform Version:** v6.0.0 | **SDKs:** v5.0.0

AxonFlow supports Google's Gemini models for LLM routing and orchestration. This guide covers configuration, supported models, and usage.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configurable-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ import (
"fmt"
"log"

axonflow "github.com/getaxonflow/axonflow-sdk-go/v4"
axonflow "github.com/getaxonflow/axonflow-sdk-go/v5"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/policy-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**Platform Version:** v5.0.0 | **SDKs:** v4.1.0
**Platform Version:** v6.0.0 | **SDKs:** v5.0.0

The Policy Templates API enables programmatic access to pre-defined policy templates. Templates provide a starting point for creating policies with configurable variables, reducing the complexity of policy creation.

Expand Down
8 changes: 4 additions & 4 deletions docs/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**SDK Version:** v4.1.0 | **Platform Version:** v5.0.0
**SDK Version:** v5.0.0 | **Platform Version:** v5.0.0

AxonFlow provides official SDKs in four languages for integrating LLM governance into your applications. All SDKs offer identical feature coverage (see [SDK Feature Coverage](../SDK_FEATURE_COVERAGE.md)) and follow the same API design principles: type-safe clients, automatic retries, and structured error handling.

Expand All @@ -12,7 +12,7 @@ AxonFlow provides official SDKs in four languages for integrating LLM governance

| SDK | Repository | Install |
|-----|-----------|---------|
| **Go** | [github.com/getaxonflow/axonflow-sdk-go](https://github.com/getaxonflow/axonflow-sdk-go) | `go get github.com/getaxonflow/axonflow-sdk-go/v4` |
| **Go** | [github.com/getaxonflow/axonflow-sdk-go](https://github.com/getaxonflow/axonflow-sdk-go) | `go get github.com/getaxonflow/axonflow-sdk-go/v5` |
| **Python** | [github.com/getaxonflow/axonflow-sdk-python](https://github.com/getaxonflow/axonflow-sdk-python) | `pip install axonflow` |
| **TypeScript** | [github.com/getaxonflow/axonflow-sdk-typescript](https://github.com/getaxonflow/axonflow-sdk-typescript) | `npm install @axonflow/sdk` |
| **Java** | [github.com/getaxonflow/axonflow-sdk-java](https://github.com/getaxonflow/axonflow-sdk-java) | See [Maven Central](#java) |
Expand All @@ -24,7 +24,7 @@ AxonFlow provides official SDKs in four languages for integrating LLM governance
### Go

```bash
go get github.com/getaxonflow/axonflow-sdk-go/v4
go get github.com/getaxonflow/axonflow-sdk-go/v5
```

```go
Expand All @@ -33,7 +33,7 @@ package main
import (
"context"
"fmt"
axonflow "github.com/getaxonflow/axonflow-sdk-go/v4"
axonflow "github.com/getaxonflow/axonflow-sdk-go/v5"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/typescript-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**SDK Version:** v4.1.0 | **Platform Version:** v5.0.0
**SDK Version:** v5.0.0 | **Platform Version:** v5.0.0

---

Expand Down Expand Up @@ -258,4 +258,4 @@ Application

---

*This document describes the architecture of the AxonFlow TypeScript SDK v4.1.0. For quick-start instructions, see [TypeScript Quickstart](typescript-quickstart.md). For the full API specification, see [TypeScript Specification](typescript-specification.md).*
*This document describes the architecture of the AxonFlow TypeScript SDK v5.0.0. For quick-start instructions, see [TypeScript Quickstart](typescript-quickstart.md). For the full API specification, see [TypeScript Specification](typescript-specification.md).*
2 changes: 1 addition & 1 deletion docs/sdk/typescript-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**SDK Version:** v4.1.0 | **Platform Version:** v5.0.0
**SDK Version:** v5.0.0 | **Platform Version:** v5.0.0

---

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/typescript-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Last Updated:** February 2026

**SDK Version:** v4.1.0 | **Platform Version:** v5.0.0
**SDK Version:** v5.0.0 | **Platform Version:** v5.0.0

**Status:** Production Ready

Expand Down Expand Up @@ -426,4 +426,4 @@ The SDK exports from `@axonflow/sdk`:

---

*This specification describes the AxonFlow TypeScript SDK v4.1.0 API surface. For architecture details, see [TypeScript Architecture](typescript-architecture.md). For a quick-start guide, see [TypeScript Quickstart](typescript-quickstart.md).*
*This specification describes the AxonFlow TypeScript SDK v5.0.0 API surface. For architecture details, see [TypeScript Architecture](typescript-architecture.md). For a quick-start guide, see [TypeScript Quickstart](typescript-quickstart.md).*
Loading
Loading