Estimate from text

A text estimate costs 10 credits with a live key. A follow-up that answers its question costs 5.

Send a description

curl https://api.wfskills.com/v1/estimates \
  -H "Authorization: Bearer $HOMETOWN_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"input": {"text": "Install 100 feet of wood privacy fence"}}'

input.text takes up to 4,000 characters. Send input.messages instead to include the conversation so far, with up to 10 messages of 1,000 characters each. Each message has a role, customer or assistant, and its content.

Optional fields

Field	Use
region	A region code from GET /v1/regions, when the job is not in the default region.
locale	The language of steps, such as es-MX.
currency	The currency code of the region. Another currency answers 422.
hourly_rate	Your rate per hour in whole units of the currency, from 1 to 2,000 (72 means USD 72.00). It replaces the going rate.
crew_size	People on the job, from 1 to 10. The hours stay the same and the time on site shrinks.
include_extras	false to skip related jobs the description also mentions.
metadata	Up to 20 keys of your own with text values of up to 500 characters, returned with the estimate.

Read the status

Status	What to do
priced	Show price and steps.
needs_detail	Ask the customer question, then send a follow-up.
unsupported	Hometown does not price this job. Nothing to retry.
unclear	Ask the customer question, or send a new description.

Answer the question

When the status is needs_detail, send the customer's answer to the same estimate:

curl https://api.wfskills.com/v1/estimates/est_<id>/follow-up \
  -H "Authorization: Bearer $HOMETOWN_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"input": {"messages": [{"role": "customer", "content": "About 100 feet"}]}}'

The answer is a new estimate with its own id.

Read, list and delete

• GET /v1/estimates/{id} returns one estimate.
• GET /v1/estimates lists them, newest first.
• DELETE /v1/estimates/{id} erases an estimate and its follow-ups. It cannot be recovered.

Hometown erases each estimate after the retention period of the account, 30 days at most.