API Reference

Enterprise API documentation for integrating OBDNC OS into your workflow.

Enterprise Tier Required: API access is available on Enterprise plans only. Contact us for custom integrations and webhook support.

Authentication

API Keys

All API requests require authentication using an API key. Include your key in the Authorization header.

Authorization: Bearer YOUR_API_KEY_HERE

To get your API key:

Log in to your OBDNC OS dashboard
Navigate to Settings → API Keys
Generate a new key for your integration

Base URL

https://api.obdnc.io/v1

Core Endpoints

Upload Project

POST/projects/upload

Upload construction plans and create a new project for analysis.

Request Body

{
  "project_name": "Downtown Office Building",
  "file": "<base64_encoded_pdf>",
  "modules": ["takeoff", "pricing", "schedule"],
  "location": "Los Angeles, CA"
}

Response (201 Created)

{
  "project_id": "proj_abc123xyz",
  "status": "processing",
  "created_at": "2026-01-22T10:30:00Z",
  "estimated_completion": "2026-01-23T18:00:00Z"
}

Get Project Status

GET/projects/:project_id/status

Check the processing status of a project.

Response (200 OK)

{
  "project_id": "proj_abc123xyz",
  "status": "completed",
  "progress": 100,
  "modules_completed": ["takeoff", "pricing", "schedule"],
  "completed_at": "2026-01-23T16:45:00Z"
}

Possible status values:

processinganalyzingcompletederror

Download Results

GET/projects/:project_id/results

Retrieve completed analysis results in JSON or Excel format.

Query Parameters

format- Response format: json or xlsx (default: json)

module- Specific module to retrieve (optional)

Response (200 OK)

{
  "project_id": "proj_abc123xyz",
  "results": {
    "takeoff": {
      "line_items": 1247,
      "total_sf": 85000,
      "data_url": "https://..."
    },
    "pricing": {
      "total_cost": 12500000,
      "cost_per_sf": 147.06,
      "breakdown_url": "https://..."
    },
    "schedule": {
      "duration_days": 365,
      "milestones": 18,
      "gantt_url": "https://..."
    }
  }
}

Code Examples

Upload a Project

curl -X POST https://api.obdnc.io/v1/projects/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_name": "Downtown Office Building",
    "file": "base64_encoded_pdf_here",
    "modules": ["takeoff", "pricing"],
    "location": "Los Angeles, CA"
  }'

Rate Limits & Pricing

Rate Limits

Standard: 100 requests/hour
Enterprise: 1,000 requests/hour
Custom: Contact us for higher limits

API Pricing

API access is included with Enterprise plans. Additional usage beyond your tier allocation is billed per project.

Coming Soon

Additional endpoints currently in development:

• Webhook subscriptions for real-time updates
• Batch project uploads
• Custom report generation endpoints
• Historical data and analytics API

Need API Access?

Contact our enterprise team to enable API access, discuss custom integrations, or request higher rate limits for your organization.