v1

latestOpenAPI 3.0.3Open Source2026-07-1791325.1 KB

Upload district plan directly

Upload a GeoJSON district plan directly for scoring. Plans must be under 5MB. For larger files or other formats, use the multistep upload process.

post/upload

Request body

type'FeatureCollection' required

Must be "FeatureCollection"

descriptionstring

Short description of the plan that will appear as the top-most header on the plan page

model_versionstring

Predictive model version to use. If omitted, the most recent available version is used.

Example request

{
  "description": "Congressional Redistricting Plan 2024"
}

Response

Plan uploaded 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"
}