Skip to content

agirails/docs

Repository files navigation

AGIRAILS Documentation

Official documentation for AGIRAILS - Payment Rails for AI Agents.

Live site: docs.agirails.io | Network: Base Mainnet (live since Feb 2026)

About AGIRAILS

AGIRAILS is the neutral settlement and trust layer for the AI agent economy. We implement the ACTP (Agent Commerce Transaction Protocol), enabling autonomous AI agents to pay each other through blockchain-based escrow on Base L2 with USDC settlement.

SDKs & Integrations

Package Language Install Docs
@agirails/sdk TypeScript npm install @agirails/sdk SDK Reference
agirails Python pip install agirails SDK Reference
n8n-nodes-agirails n8n npm install n8n-nodes-agirails n8n Guide
Claude Plugin Claude Code Built-in Claude Guide
OpenClaw Skill OpenClaw Built-in OpenClaw Guide

Features

  • Three-tier SDK API - Basic (provide/request), Standard (Agent), Advanced (ACTPClient)
  • Multi-protocol support - ACTP escrow, x402 instant payments, ERC-8004 identity
  • Full TS/Python parity - Same functionality in both languages
  • CLI tooling - 14 commands for init, deploy, register, publish, and more
  • AI Assistant - Built-in docs assistant powered by RAG
  • Interactive Playground - Try the SDK in your browser
  • Visual Canvas - Drag-and-drop agent economy builder
  • n8n Integration - Visual workflow automation

Documentation Structure

docs/
├── index.md                 # What is AGIRAILS?
├── installation.md          # Setup guide
├── quick-start.md           # 15-minute quickstart
├── cli-reference.md         # CLI commands reference
├── developer-responsibilities.md
├── concepts/                # Core concepts (ACTP, escrow, identity)
├── guides/
│   ├── agents/              # Provider, Consumer, Autonomous agents
│   └── integrations/        # n8n, Claude, LangChain, CrewAI, OpenClaw
├── cookbook/                 # Production recipes
├── sdk-reference/           # Full API reference
│   ├── basic-api.md         # provide(), request()
│   ├── standard-api.md      # Agent class
│   └── advanced-api/        # ACTPClient, Kernel, Escrow, Events
├── contract-reference.md    # Smart contract docs
└── examples/                # Code examples index

Local Development

# Install dependencies
npm install

# Start dev server
npm run start

# Build for production
npm run build

# Run tests
npx vitest

# Index docs for AI Assistant (requires Upstash credentials)
npx ts-node scripts/index-docs.ts

Contributing

We welcome contributions! Here's how:

  1. Fork this repository
  2. Create a branch: git checkout -b docs/your-improvement
  3. Make your changes
  4. Test locally with npm run start
  5. Submit a Pull Request

Contribution Ideas

  • Fix typos or improve clarity
  • Add code examples (TypeScript and Python)
  • Improve diagrams
  • Translate content
  • Report issues

Related Repositories

Repository Description
sdk-js TypeScript SDK
sdk-python Python SDK
sdk-examples SDK usage examples (TS + Python)
actp-kernel Smart contracts (Solidity)
n8n-nodes-actp n8n community node
claude-plugin Claude Code plugin
openclaw-skill OpenClaw skill
aips AGIRAILS Improvement Proposals

Community

License

Apache-2.0 - see LICENSE

About

Official AGIRAILS documentation - Payment Rails for AI Agents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages