Quickstart

Run the server locally, set your API key, and call the API. Every example below works against the real product.

1. Start the server

python3 -m permitpilot.app   # stdlib only, no install needed

2. Set your API key

export PERMITPILOT_API_KEY="your-key-here"   # see .env.example

When the key is set, programmatic /api/* calls require an X-API-Key header. Full endpoint reference: OPENAPI.md in the repo.

3. Try it

Track a permit

curl -s -X POST localhost:8471/api/permits -H "Content-Type: application/json" -H "X-API-Key: $PERMITPILOT_API_KEY" -d '{"address":"123 Main St","jurisdiction_id":"miami-dade-fl","permit_type":"roofing"}'

Advance the status

curl -s -X PUT localhost:8471/api/permits/1 -H "Content-Type: application/json" -H "X-API-Key: $PERMITPILOT_API_KEY" -d '{"status":"submitted"}'

Follow-ups due

curl -s localhost:8471/api/followups/due

Follow-up script

curl -s localhost:8471/api/permits/1/followup