Documentation
API Documentation
Everything you need to integrate PatternPulse AI into your workflow.
API Overview
PatternPulse AI exposes a RESTful API built on FastAPI. The API accepts PDF uploads, processes them through the ML pipeline, and returns classification results along with redacted documents.
Base URL:
ENDPOINT
https://api.patternpulse.ai/v1Authentication: All API requests require a Bearer token in the Authorization header.
CURL
curl -X POST https://api.patternpulse.ai/v1/analyze \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@document.pdf"
All API responses are returned in JSON format. File downloads are returned as binary streams.
Supported File Types
| Format | Extension | Max Size | Status |
|---|---|---|---|
| 50 MB | Supported | ||
| DOCX | .docx | — | Coming Soon |
| DWG | .dwg | — | Planned |
| DXF | .dxf | — | Planned |
Only PDF files are currently accepted. Uploading unsupported formats will return a 415 error.
Classification Categories
PatternPulse AI classifies construction documents into six standard engineering disciplines used across the AEC industry.
| Discipline | Code | Description |
|---|---|---|
| Architectural | ARCH | Floor plans, elevations, sections, interior layouts |
| Structural | STR | Foundation plans, framing, structural details |
| Mechanical | MECH | HVAC layouts, ductwork, mechanical schedules |
| Plumbing | PLMB | Piping layouts, fixture schedules, drainage |
| Electrical | ELEC | Panel schedules, lighting plans, power layouts |
| Fire Protection | FIRE | Sprinkler layouts, fire alarm plans |
Sensitive Information Detection
| Type | Method | Examples |
|---|---|---|
| Person Names | spaCy NER | John Doe, Sarah Lee |
| Email Addresses | Regex + NER | user@example.com |
| Phone Numbers | Regex | (555) 123-4567 |
| Physical Addresses | spaCy NER | 123 Main Street, Suite 100 |
| Project IDs | Regex | PRJ-2026-0042 |
Error Codes
| Code | Message | Description |
|---|---|---|
400 | Bad Request | Missing or invalid parameters |
401 | Unauthorized | Invalid or missing API key |
413 | Payload Too Large | File exceeds 50 MB |
415 | Unsupported Media Type | Format not supported |
422 | Unprocessable Entity | Cannot extract text |
429 | Rate Limited | Too many requests |
500 | Internal Server Error | Server-side error |
Contact & Support
Have questions, feedback, or need help integrating PatternPulse AI? Reach out through any of the channels below.
support@patternpulse.ai
GitHub
github.com/patternpulse
Documentation
docs.patternpulse.ai