Plandex · Schema

Plan

A Plandex plan: a durable, branchable unit of AI coding work scoped to a project and persisted across sessions.

AIAI Coding AgentDeveloper ToolsOpen SourceCLITerminalLLMCoding AssistantAgentsGoContext ManagementPlansSelf-HostedREST

Properties

Name Type Description
id string Server-assigned plan ID.
name string Human-readable plan name (auto-generated after the first prompt if not set).
projectId string ID of the project the plan belongs to.
ownerId string ID of the user that created the plan.
currentBranch string Branch currently active on the plan.
contextTokens integer Total tokens currently loaded into the plan's context.
convoTokens integer Total tokens in the plan conversation prior to summarization.
archivedAt stringnull
createdAt string
updatedAt string
View JSON Schema on GitHub

JSON Schema

plandex-server-plan-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/plandex/main/json-schema/plandex-server-plan-schema.json",
  "title": "Plan",
  "description": "A Plandex plan: a durable, branchable unit of AI coding work scoped to a project and persisted across sessions.",
  "type": "object",
  "required": ["id", "name", "projectId"],
  "properties": {
    "id": {"type": "string", "description": "Server-assigned plan ID."},
    "name": {"type": "string", "description": "Human-readable plan name (auto-generated after the first prompt if not set)."},
    "projectId": {"type": "string", "description": "ID of the project the plan belongs to."},
    "ownerId": {"type": "string", "description": "ID of the user that created the plan."},
    "currentBranch": {"type": "string", "default": "main", "description": "Branch currently active on the plan."},
    "contextTokens": {"type": "integer", "minimum": 0, "description": "Total tokens currently loaded into the plan's context."},
    "convoTokens": {"type": "integer", "minimum": 0, "description": "Total tokens in the plan conversation prior to summarization."},
    "archivedAt": {"type": ["string", "null"], "format": "date-time"},
    "createdAt": {"type": "string", "format": "date-time"},
    "updatedAt": {"type": "string", "format": "date-time"}
  },
  "additionalProperties": false
}