v1

latestOpenAPI 3.0.3Open Source2026-07-1791325.1 KB

Re-score an existing plan

Re-score an existing district plan to update to the most recent versions of the model or to change parts of the description and other configuration details.

District plans shared with PlanScore are kept indefinitely.

post/clone

Request body

idstring required

Unique identifier of the existing plan to re-score

descriptionstring

Short description of the plan (optional, will override original if provided)

incumbentsstring[]

Ordered list of incumbency scenario strings for each district

vote_swingsnumber[]

Ordered list of vote swings to model for each district

model_versionstring

Predictive model version. If omitted, the most recent one is used.

Example request

{
  "id": "20210307T032912.752515089Z",
  "description": "Congressional Redistricting Plan 2024",
  "incumbents": [
    "R",
    "D",
    "O"
  ],
  "vote_swings": [
    0.04,
    0.05,
    0.06
  ]
}

Response

Plan cloned and re-scoring started successfully

index_urlstring uri required

Machine-readable JSON representation of the plan being scored. The response follows the structure defined in the PlanIndex schema.

plan_urlstring uri required

Human-readable web page with graphs and maps for the plan

Example response

{
  "index_url": "https://planscore.s3.amazonaws.com/uploads/20210307T032912.752515089Z/index.json",
  "plan_url": "https://planscore.org/plan.html?20210307T032912.752515089Z"
}