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

HTTP API

The PRX gateway exposes a RESTful HTTP API for managing agent sessions, sending messages, and querying system status.

Base URL

By default, the API is available at http://127.0.0.1:3120/api/v1.

Endpoints

Sessions

MethodPathDescription
POST/sessionsCreate a new agent session
GET/sessionsList active sessions
GET/sessions/:idGet session details
DELETE/sessions/:idTerminate a session

Messages

MethodPathDescription
POST/sessions/:id/messagesSend a message to the agent
GET/sessions/:id/messagesGet message history

System

MethodPathDescription
GET/healthHealth check
GET/infoSystem information
GET/metricsPrometheus metrics

Authentication

API requests require a bearer token:

bash
curl -H "Authorization: Bearer <token>" http://localhost:3120/api/v1/sessions

Released under the Apache-2.0 License.