AMTP Protocol & Agentry Gateway
Complete documentation for building with the agentic internet
Everything you need to understand, implement, and deploy AMTP-based solutions. From protocol specifications to deployment guides and API references.
Quick Start
Get up and running with AMTP in minutes.
Deploy Agentry Gateway with Docker
# Pull the latest image
docker pull agentry/gateway:latest
# Run with basic configuration
docker run -d \
--name agentry-gateway \
-p 8080:8080 \
-e DOMAIN=yourcompany.com \
-e ADMIN_EMAIL=admin@yourcompany.com \
agentry/gateway:latest
# Check status
curl http://localhost:8080/healthDocumentation Sections
Comprehensive guides for every aspect of AMTP and Agentry.
Protocol Specification
Complete AMTP v1.0 protocol specification including message format, delivery guarantees, and security requirements.
- Message structure & format
- Delivery guarantees
- Security & authentication
- Schema validation
Gateway Setup
Deployment guides for Agentry Gateway in various environments and configurations.
- Docker deployment
- Kubernetes setup
- Configuration options
- Monitoring & logging
API Reference
Complete API documentation for Agentry Gateway REST endpoints and webhooks.
- REST API endpoints
- Webhook configuration
- Authentication methods
- Error handling
Schema Registry
Understanding and working with AMTP message schemas and validation.
- Schema definition
- Validation rules
- Custom schemas
- Schema evolution
Security Guide
Best practices for securing AMTP communications and gateway deployments.
- Digital signatures
- Encryption at rest
- Network security
- Access control
Integration Examples
Real-world examples and tutorials for integrating AMTP into your applications.
- LangChain integration
- CrewAI workflows
- Custom agent development
- Legacy system bridges
AMTP Protocol Specification
The complete specification for the Agent Message Transfer Protocol v1.0.
Message Format
AMTP messages are structured JSON documents that contain all necessary information for routing, delivery, and processing by autonomous systems.
{
"version": "1.0",
"messageId": "msg_123456789",
"timestamp": "2025-01-27T10:30:00Z",
"from": "agent@company.com",
"to": "workflow@partner.com",
"replyTo": "notifications@company.com",
"priority": "normal",
"ttl": 3600,
"schema": "https://schemas.agentry.site/workflow/v1",
"payload": {
"action": "process_order",
"data": {
"orderId": "ORD-001",
"amount": 99.99,
"currency": "USD"
}
},
"metadata": {
"correlationId": "corr_abc123",
"tags": ["urgent", "billing"]
},
"signature": {
"algorithm": "RS256",
"keyId": "key_123",
"value": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}
}Required Fields
- version - AMTP protocol version (currently "1.0")
- messageId - Unique identifier for the message
- timestamp - ISO 8601 timestamp of message creation
- from - Sender address in format agent@domain
- to - Recipient address in format agent@domain
- payload - The actual message content
Optional Fields
- replyTo - Address for replies (defaults to 'from')
- priority - Message priority: low, normal, high, urgent
- ttl - Time-to-live in seconds (default: 86400)
- schema - JSON schema URI for payload validation
- metadata - Additional key-value pairs
- signature - Digital signature for message integrity
Gateway Setup Guide
Deploy and configure Agentry Gateway for your environment.
Docker Compose Setup
For production deployments, use Docker Compose with external volumes for data persistence.
# docker-compose.yml
version: '3.8'
services:
agentry-gateway:
image: agentry/gateway:latest
container_name: agentry-gateway
ports:
- "8080:8080"
- "25:25" # SMTP
- "587:587" # SMTP submission
environment:
- DOMAIN=yourcompany.com
- ADMIN_EMAIL=admin@yourcompany.com
- DATABASE_URL=postgresql://user:pass@db:5432/agentry
- REDIS_URL=redis://redis:6379
- LOG_LEVEL=info
volumes:
- ./config:/app/config
- ./data:/app/data
- ./logs:/app/logs
depends_on:
- db
- redis
restart: unless-stopped
db:
image: postgres:15
environment:
- POSTGRES_DB=agentry
- POSTGRES_USER=agentry
- POSTGRES_PASSWORD=secure_password
volumes:
- postgres_data:/var/lib/postgresql/data
redis:
image: redis:7-alpine
volumes:
- redis_data:/data
volumes:
postgres_data:
redis_data:Additional Resources
Community resources, tools, and helpful links.
Need Help?
Can't find what you're looking for? We're here to help.