Developers

REST API Reference

The Proof-OS API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

The Proof API uses Bearer tokens to authenticate requests. You can view and manage your API keys in the Proof-OS Dashboard under Settings > Integrity & Security.

Security Notice: Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authorization: Bearer prf_live_xxxxxxxxxxxxxxxxxxxxxxxx

Rate Limits

To prevent abuse, we apply rate limits to all API endpoints. The standard limit is 100 requests per second per IP address.

Jobs API

Create a Job

Initializes a new emergency dispatch workflow.

POST /v1/jobs

curl -X POST https://api.proofco.io/v1/jobs \
  -H "Authorization: Bearer prf_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "water_mitigation",
    "severity": "category_3",
    "location": {
      "address": "123 Main St",
      "zip_code": "90210"
    },
    "customer": {
      "phone": "+14155552671"
    }
  }'

Retrieve a Job

Retrieves the details of an existing job, including its current state machine status and active telemetry.

GET /v1/jobs/{job_id}

Vision AI API

Upload LiDAR Payload

Upload a raw spatial mesh array for auto-estimation processing.

PUT /v1/vision/scan/{job_id}