Hometown Workforce Estimate API
Estimates for home-service jobs: send what the customer wrote, the conversation so far, or photos, and get the hours, the rate, a step-by-step breakdown and a price range, priced by the same engine as Hometown Workforce's own chat.
Authenticate with Authorization: Bearer hw_live_… (or hw_test_…). A test key never spends credits. Text that starts with sandbox: followed by an entry name answers from a fixed example without calling the model; the entries are priced, needs_detail, unsupported, unclear, rate_limited, insufficient_credits, content_rejected, timeout, async and failed. Any other text with a test key is estimated for real, up to 200 times a day. Creating an estimate or a follow-up needs an Idempotency-Key. With mode: async an estimate answers 202 at once and finishes in the background. Subscribe a webhook endpoint to estimate.completed and estimate.failed to hear when it finishes; every event is signed in the Hometown-Signature header. With the Records add-on, keep your end customers in /v1/customers and any JSON document in /v1/records. Errors are application/problem+json with a stable code.
Authentication
- HTTP: Bearer Auth
hw_live_… or hw_test_…
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |