{"openapi":"3.1.0","info":{"title":"Hank's Carpet Cleaning booking API","version":"1.0.0","description":"Official booking tools for Hank's Carpet Cleaning, an award-winning carpet, upholstery, tile & grout and hardwood/LVP cleaning company in Dallas-Fort Worth, Texas (Monday to Saturday). Flow: get_price_quote (exact price) → check_service_area (job ZIP) → get_available_times (real open times) → read everything back to the customer → book_appointment only after they clearly say yes. Quote only prices these tools return (they include the visit minimum, bundle pricing and coupons; tax is 8.25% on top). Offer only times get_available_times returned. Payment is by invoice after the job; nothing is paid when booking. For anything else (commercial bids, changes, cancellations, complaints, large or unusual jobs) the customer should call or text (817) 697-7500. The same tools are available as a remote MCP server at https://hankscarpetcleaning.com/api/mcp/.","contact":{"name":"Hank's Carpet Cleaning","url":"https://hankscarpetcleaning.com","email":"info@hankscarpetcleaning.com"}},"servers":[{"url":"https://hankscarpetcleaning.com"}],"paths":{"/api/ai/get_business_info/":{"post":{"operationId":"get_business_info","summary":"Business info and price list","description":"Hank's Carpet Cleaning services, price list, visit minimums, hours, service area, what's included and how booking works.","x-openai-isConsequential":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"Tool result. Failures come back with `error` (and `ok: false` for bookings), worded for the customer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/ai/get_price_quote/":{"post":{"operationId":"get_price_quote","summary":"Get an exact price","description":"Exact price for a home cleaning visit from Hank's price list, with the visit minimum, bundle pricing, an optional coupon and 8.25% Texas sales tax applied. Returns each line, the total before tax and the total with tax.","x-openai-isConsequential":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"object","description":"Everything to clean on this visit. Leave out anything not included (0 / false).","properties":{"rooms":{"type":"integer","minimum":0,"maximum":20,"description":"Carpeted rooms (bedrooms, living room, den, office, bonus room...)."},"stairs":{"type":"integer","minimum":0,"maximum":4,"description":"Carpeted staircases."},"hallways":{"type":"integer","minimum":0,"maximum":6,"description":"Carpeted hallways."},"closets":{"type":"integer","minimum":0,"maximum":4,"description":"Master (walk-in) closets."},"rugs":{"type":"integer","minimum":0,"maximum":10,"description":"Area rugs, cleaned on site."},"petOdor":{"type":"boolean","description":"Pet accidents/odor in the carpet (not priced; tells the tech what to expect)."},"sectionals":{"type":"integer","minimum":0,"maximum":4,"description":"Sectional sofas."},"sofas":{"type":"integer","minimum":0,"maximum":6,"description":"Sofas / couches (not sectionals)."},"loveseats":{"type":"integer","minimum":0,"maximum":6,"description":"Loveseats."},"armchairs":{"type":"integer","minimum":0,"maximum":8,"description":"Armchairs / recliners / accent chairs."},"ottomans":{"type":"integer","minimum":0,"maximum":6,"description":"Ottomans."},"headboards":{"type":"integer","minimum":0,"maximum":4,"description":"Upholstered headboards ($60 each)."},"upholsteryPetOdor":{"type":"boolean","description":"Pet accidents/odor on the upholstery (not priced)."},"tileSqft":{"type":"integer","minimum":0,"maximum":10000,"description":"Square feet of tile & grout floor cleaning."},"hardwoodSqft":{"type":"integer","minimum":0,"maximum":10000,"description":"Square feet of hardwood and/or LVP (luxury vinyl plank) floor cleaning, combined."},"groutSealing":{"type":"boolean","description":"Grout color sealing: a free in-home consultation, priced on site."},"naturalStone":{"type":"boolean","description":"Natural stone (travertine, marble...): a free in-home consultation."},"garageEpoxy":{"type":"boolean","description":"Garage floor coating (epoxy, by sister company Epoxy Panda): a free in-home consultation."}},"additionalProperties":false},"coupon":{"type":"string","description":"Coupon code the customer gave (one per order). Omit if none."}},"required":["items"],"additionalProperties":false}}}},"responses":{"200":{"description":"Tool result. Failures come back with `error` (and `ok: false` for bookings), worded for the customer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/ai/check_service_area/":{"post":{"operationId":"check_service_area","summary":"Check a ZIP code","description":"Checks whether Hank's serves a 5-digit ZIP code (Dallas-Fort Worth) for home cleanings and free consultations.","x-openai-isConsequential":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"zip":{"type":"string","description":"5-digit ZIP code of the job."}},"required":["zip"],"additionalProperties":false}}}},"responses":{"200":{"description":"Tool result. Failures come back with `error` (and `ok: false` for bookings), worded for the customer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/ai/get_available_times/":{"post":{"operationId":"get_available_times","summary":"See open times","description":"Open start times on Hank's live job calendar for a specific visit and ZIP code. The visit's items set the job's length and which start times it can take, so the times depend on the items. Cleaning times are 1-hour arrival windows. Returns up to 8 times (at most 3 per day) plus the next open days.","x-openai-isConsequential":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"object","description":"Everything to clean on this visit. Leave out anything not included (0 / false).","properties":{"rooms":{"type":"integer","minimum":0,"maximum":20,"description":"Carpeted rooms (bedrooms, living room, den, office, bonus room...)."},"stairs":{"type":"integer","minimum":0,"maximum":4,"description":"Carpeted staircases."},"hallways":{"type":"integer","minimum":0,"maximum":6,"description":"Carpeted hallways."},"closets":{"type":"integer","minimum":0,"maximum":4,"description":"Master (walk-in) closets."},"rugs":{"type":"integer","minimum":0,"maximum":10,"description":"Area rugs, cleaned on site."},"petOdor":{"type":"boolean","description":"Pet accidents/odor in the carpet (not priced; tells the tech what to expect)."},"sectionals":{"type":"integer","minimum":0,"maximum":4,"description":"Sectional sofas."},"sofas":{"type":"integer","minimum":0,"maximum":6,"description":"Sofas / couches (not sectionals)."},"loveseats":{"type":"integer","minimum":0,"maximum":6,"description":"Loveseats."},"armchairs":{"type":"integer","minimum":0,"maximum":8,"description":"Armchairs / recliners / accent chairs."},"ottomans":{"type":"integer","minimum":0,"maximum":6,"description":"Ottomans."},"headboards":{"type":"integer","minimum":0,"maximum":4,"description":"Upholstered headboards ($60 each)."},"upholsteryPetOdor":{"type":"boolean","description":"Pet accidents/odor on the upholstery (not priced)."},"tileSqft":{"type":"integer","minimum":0,"maximum":10000,"description":"Square feet of tile & grout floor cleaning."},"hardwoodSqft":{"type":"integer","minimum":0,"maximum":10000,"description":"Square feet of hardwood and/or LVP (luxury vinyl plank) floor cleaning, combined."},"groutSealing":{"type":"boolean","description":"Grout color sealing: a free in-home consultation, priced on site."},"naturalStone":{"type":"boolean","description":"Natural stone (travertine, marble...): a free in-home consultation."},"garageEpoxy":{"type":"boolean","description":"Garage floor coating (epoxy, by sister company Epoxy Panda): a free in-home consultation."}},"additionalProperties":false},"coupon":{"type":"string","description":"Coupon code the customer gave (one per order). Omit if none."},"zip":{"type":"string","description":"5-digit ZIP of the job address (not needed for consultation-only visits)."},"from_date":{"type":"string","description":"Optional YYYY-MM-DD: only times on or after this day (Central time)."},"day":{"type":"string","description":"Optional YYYY-MM-DD: only times on this one day."}},"required":["items"],"additionalProperties":false}}}},"responses":{"200":{"description":"Tool result. Failures come back with `error` (and `ok: false` for bookings), worded for the customer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/ai/book_appointment/":{"post":{"operationId":"book_appointment","summary":"Book the appointment","description":"Books the visit on Hank's calendar through the same path as the website's booking form and sends the customer a confirmation text. Payment is by invoice after the job. Nothing is booked unless customerConfirmed is true (the customer confirmed the items, total with tax, time and address) and smsConsent is true (the customer agreed to appointment texts).","x-openai-isConsequential":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"object","description":"Everything to clean on this visit. Leave out anything not included (0 / false).","properties":{"rooms":{"type":"integer","minimum":0,"maximum":20,"description":"Carpeted rooms (bedrooms, living room, den, office, bonus room...)."},"stairs":{"type":"integer","minimum":0,"maximum":4,"description":"Carpeted staircases."},"hallways":{"type":"integer","minimum":0,"maximum":6,"description":"Carpeted hallways."},"closets":{"type":"integer","minimum":0,"maximum":4,"description":"Master (walk-in) closets."},"rugs":{"type":"integer","minimum":0,"maximum":10,"description":"Area rugs, cleaned on site."},"petOdor":{"type":"boolean","description":"Pet accidents/odor in the carpet (not priced; tells the tech what to expect)."},"sectionals":{"type":"integer","minimum":0,"maximum":4,"description":"Sectional sofas."},"sofas":{"type":"integer","minimum":0,"maximum":6,"description":"Sofas / couches (not sectionals)."},"loveseats":{"type":"integer","minimum":0,"maximum":6,"description":"Loveseats."},"armchairs":{"type":"integer","minimum":0,"maximum":8,"description":"Armchairs / recliners / accent chairs."},"ottomans":{"type":"integer","minimum":0,"maximum":6,"description":"Ottomans."},"headboards":{"type":"integer","minimum":0,"maximum":4,"description":"Upholstered headboards ($60 each)."},"upholsteryPetOdor":{"type":"boolean","description":"Pet accidents/odor on the upholstery (not priced)."},"tileSqft":{"type":"integer","minimum":0,"maximum":10000,"description":"Square feet of tile & grout floor cleaning."},"hardwoodSqft":{"type":"integer","minimum":0,"maximum":10000,"description":"Square feet of hardwood and/or LVP (luxury vinyl plank) floor cleaning, combined."},"groutSealing":{"type":"boolean","description":"Grout color sealing: a free in-home consultation, priced on site."},"naturalStone":{"type":"boolean","description":"Natural stone (travertine, marble...): a free in-home consultation."},"garageEpoxy":{"type":"boolean","description":"Garage floor coating (epoxy, by sister company Epoxy Panda): a free in-home consultation."}},"additionalProperties":false},"coupon":{"type":"string","description":"Coupon code the customer gave (one per order). Omit if none."},"slot":{"type":"string","description":"Start time: a `slot` value as returned by get_available_times."},"contact":{"type":"object","description":"The customer's details for the appointment.","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string","description":"10-digit US mobile number (gets the confirmation and reminder texts)."},"email":{"type":"string","description":"Optional."},"address":{"type":"string","description":"Street address of the job, with apt/unit."},"city":{"type":"string"},"zip":{"type":"string","description":"5-digit ZIP of the job address."},"notes":{"type":"string","description":"Optional: gate code, parking, pets, or notes for the technician."}},"required":["firstName","lastName","phone","address","city","zip"],"additionalProperties":false},"smsConsent":{"type":"boolean","description":"True only if the customer agreed to receive appointment texts (confirmation, reminders, updates). Required."},"customerConfirmed":{"type":"boolean","description":"True only if the customer confirmed the items, price with tax, time and address."},"dryRun":{"type":"boolean","description":"Testing only: check everything but book nothing."}},"required":["items","slot","contact","smsConsent","customerConfirmed"],"additionalProperties":false}}}},"responses":{"200":{"description":"Tool result. Failures come back with `error` (and `ok: false` for bookings), worded for the customer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}}}}