API Reference
Integrate automated building code compliance directly into your CI/CD pipeline or internal tools.
Authentication
Authenticate your requests using the Authorization header.
Authorization: Bearer <YOUR_API_KEY>
Scan Document
Upload a PDF file for immediate analysis.
POST
https://api.planpass.ai/v1/scan
Parameters
| Field | Type | Description |
|---|---|---|
| file | Binary | The PDF document to analyze (Max 50MB). |
| jurisdiction | String | (Optional) "San Francisco", "Seattle", etc. |
Example Request
import requests
url = "https://api.planpass.ai/v1/scan"
files = {"file": open("adu_plan.pdf", "rb")}
headers = {"Authorization": "Bearer sk_live_..."}
response = requests.post(url, files=files, headers=headers)
print(response.json())