Plandex Health API

openapi: 3.1.0
info:
  title: Plandex Server Accounts Health API
  description: Management and orchestration REST API exposed by the Plandex server (open-source, Go) used by the Plandex CLI/REPL to drive long-running coding plans across organizations, projects, plans, branches, context, conversation, model packs, and configuration. The same API powered Plandex Cloud (winding down 2025-10-03) and now powers self-hosted / local-mode deployments via Docker. Default local-mode bind is http://localhost:8099.
  version: '2'
  contact:
    name: Plandex AI
    url: https://plandex.ai
  license:
    name: MIT
    url: https://github.com/plandex-ai/plandex/blob/main/LICENSE
  termsOfService: https://plandex.ai/terms
servers:
- url: http://localhost:8099
  description: Default self-hosted / local-mode Plandex server (Docker)
- url: https://api.plandex.ai
  description: Plandex Cloud (winding down as of 2025-10-03; no longer accepting new users)
security:
- BearerAuth: []
tags:
- name: Health
  description: Operational health and version endpoints.
paths:
  /health:
    get:
      tags:
      - Health
      summary: Get Server Health
      description: Liveness probe used by load balancers and monitoring.
      operationId: getHealth
      responses:
        '200':
          description: Server is healthy.
          content:
            text/plain:
              schema:
                type: string
                example: OK
  /version:
    get:
      tags:
      - Health
      summary: Get Server Version
      description: Returns the running server version string from version.txt.
      operationId: getVersion
      responses:
        '200':
          description: Version string.
          content:
            text/plain:
              schema:
                type: string
                example: 2.2.3
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token issued by the Plandex server on sign-in. Used by the CLI/REPL for all authenticated API calls.