API & Developer Hub
Build on top of OmniTakeoff.
REST API, webhooks, and SDKs ship with every account. Full OpenAPI 3.1 spec, HMAC-signed event delivery, TypeScript + Python clients generated from the spec.
Surfaces
Three ways to integrate
REST API
Full coverage of every entity. Bearer-token auth, JSON request + response, idempotency keys on writes.
- · OpenAPI 3.1 spec
- · 250+ documented endpoints
- · Cursor-paginated lists
- · Tenant-scoped via org-id header
Webhooks
Subscribe to lifecycle events. HMAC-signed delivery, automatic retries with exponential backoff, per-event dedup.
- · 10+ event types
- · At-least-once delivery
- · 7-day replay window
- · Signature verification helper SDKs
SDKs
TypeScript and Python clients generated from the OpenAPI spec. Stay in sync with API changes automatically.
- · npm:
@omnitakeoff/sdk - · pip:
omnitakeoff - · Generated from OpenAPI
- · Full type coverage
API preview
A few of the most-used endpoints
Full reference at /docs once you're an authenticated user. Open spec available on request for prospects.
| Method | Path | Description |
|---|---|---|
| POST | /api/v1/documents/upload | Upload a plan set, kicks off processing |
| GET | /api/v1/documents/{id} | Document with status + ai_analysis |
| GET | /api/v1/takeoffs/{id} | Takeoff + line items + scope breakdown |
| POST | /api/v1/estimates/{id}/export?format=xlsx | Generate XLSX export |
| POST | /api/v1/symbol-annotations/{id}/confirm | Promote vision claim to ground-truth |
| GET | /api/v1/cost-sanity/cost-estimates/{id} | Run sanity checks on estimate |
| GET | /api/v1/documents/{id}/compare/{other_id} | Diff two revisions |
| POST | /api/v1/assembly-catalog/{slug}/clone | Clone catalog assembly into org library |
Webhook events
What we'll send you
document.uploadeddocument.processing.completeddocument.processing.failedtakeoff.completedtakeoff.line_item.confidence_lowestimate.approvedestimate.exportedreview.queue.item_addedbid.submittedversion.compare.completedSecurity
Built for production from day one
Auth
Bearer-token + scoped API keys. Org-level + per-key rate limits. Auto-rotate available.
Tenancy
Postgres RLS plus app-layer tenant scoping. Every query hits the org-id filter. Audit log on every write.
Compliance
SOC 2 Type II in progress. GDPR + CCPA data-subject rights endpoints in production.
Ready to build?
Get an API key with your pilot account.
API access is included on every plan. Enterprise tier adds dedicated engineering hours per quarter for custom integrations.