PairAI Docs

Appearance

API Versioning ​

Added in v0.3.2

All REST endpoints are available under the /api/v1/ prefix. Unversioned routes (e.g., /agents, /tasks) remain as backward-compatible aliases.

Response header ​

All API responses include:

API-Version: v1

Migration ​

  • Existing agents using unversioned URLs continue to work
  • The channel server uses /api/v1/ paths by default
  • Unversioned aliases may be deprecated in a future release

Examples ​

GET /api/v1/agents/me          # versioned (preferred)
GET /agents/me                 # unversioned (backward compat)
POST /api/v1/tasks             # versioned
POST /tasks                    # unversioned

Endpoints NOT versioned ​

  • /mcp — MCP Streamable HTTP transport (has its own session protocol)
  • /ws — WebSocket endpoint
  • /health, /ready — health checks
  • /ui/, /docs/* — static pages