API Documentation

Getting Started

Three steps to classify your first construction image:

1. 1

   Create an account

   Sign up for a free account to access the dashboard.

2. 2

   Generate an API key

   Go to API Keys in the dashboard and create a new key. Copy it — the full key is only shown once.

3. 3

   Make your first request

   Send a construction site photo to the classification endpoint using the code examples below.

Authentication

All API requests require an API key sent via the x-api-key header. Keys start with sk_live_ and can be managed in the dashboard.

bashcurl -X POST YOUR_API_URL/v1/classify \
  -H "x-api-key: sk_live_your_key_here" \
  -F "file=@photo.jpg"

POST /v1/classify

Upload an image and receive construction classification results.

Request

• Content-Type: multipart/form-data
• file: JPEG or PNG image (validated by magic bytes)
• Max size: 10 MB

Response

Returns classification results with category, types, and metadata:

json{
  "category": {
    "prediction": "Structural",
    "confidence": 0.9234,
    "confident": true
  },
  "types": [
    {
      "prediction": "Concrete Work",
      "confidence": 0.8567,
      "items": ["Foundation", "Column", "Beam"]
    }
  ],
  "metadata": {
    "image_path": "upload",
    "inference_time_seconds": 1.23,
    "model": "manifold-v1"
  }
}

Response Fields

Code Examples

Replace YOUR_API_URL with your deployment URL.

pythonimport requests

response = requests.post(
    "YOUR_API_URL/v1/classify",
    headers={"x-api-key": "sk_live_..."},
    files={"file": open("site_photo.jpg", "rb")}
)
print(response.json())

Rate Limits & Quotas

Each plan has per-minute rate limits and monthly request quotas. Exceeding either returns a 429 response.

Error Responses

All errors follow a consistent format with a human-readable message and the HTTP status code in the body:

json{
  "detail": "Image too large (12345678 bytes). Maximum is 10485760 bytes.",
  "status_code": 413
}

Validation errors (422) return a semicolon-separated string of field errors instead of an array, making them easy to display in a UI toast or alert.

Error Codes