openapi: 3.1.0
info:
  title: Plandex Server Accounts Projects 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: Projects
  description: Project containers that group plans, mapped to a working directory.
paths:
  /projects:
    get:
      tags:
      - Projects
      summary: List Projects
      description: List projects in the current org.
      operationId: listProjects
      responses:
        '200':
          description: List of projects.
    post:
      tags:
      - Projects
      summary: Create Project
      description: Create a new project container for plans.
      operationId: createProject
      responses:
        '201':
          description: Project created.
  /projects/{projectId}/set_plan:
    put:
      tags:
      - Projects
      summary: Set Current Plan For Project
      description: Set the active plan for a project.
      operationId: projectSetPlan
      parameters:
      - in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Active plan set.
  /projects/{projectId}/rename:
    put:
      tags:
      - Projects
      summary: Rename Project
      description: Rename an existing project.
      operationId: renameProject
      parameters:
      - in: path
        name: projectId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project renamed.
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.