Skip to content
This page was generated and translated with the assistance of AI. If you spot any inaccuracies, feel free to help improve it. Edit on GitHub

Gateway

The PRX gateway is the network-facing layer that exposes agent capabilities through multiple protocols. It provides HTTP REST APIs, WebSocket connections for real-time streaming, and webhook endpoints for event-driven integrations.

Overview

The gateway runs as part of the PRX daemon and handles:

  • HTTP API -- RESTful endpoints for session management, tool execution, and configuration
  • WebSocket -- bidirectional streaming for real-time agent interactions
  • Webhooks -- outbound event notifications for integrations
  • Middleware -- authentication, rate limiting, CORS, and request logging

Architecture

┌─────────────────────────────────┐
│           Gateway                │
│  ┌──────────┐  ┌─────────────┐  │
│  │ HTTP API │  │  WebSocket  │  │
│  └────┬─────┘  └──────┬──────┘  │
│       │               │         │
│  ┌────┴───────────────┴──────┐  │
│  │       Middleware Stack     │  │
│  └────────────┬──────────────┘  │
│               │                  │
│  ┌────────────┴──────────────┐  │
│  │      Agent Runtime         │  │
│  └───────────────────────────┘  │
└─────────────────────────────────┘

Configuration

toml
[gateway]
bind = "127.0.0.1:3120"
tls_cert = ""
tls_key = ""

[gateway.cors]
allowed_origins = ["*"]
allowed_methods = ["GET", "POST", "PUT", "DELETE"]

Released under the Apache-2.0 License.