Remodel Your Vibe API Docs
Documentation for the Remodel Your Vibe REST API and MCP server. Use them to look up our services, price ranges and service areas, search the website and read any page as text. Everything here is public and read-only. There is no API key, no sign-up and no cost.
When to Use This
Remodel Your Vibe is a licensed residential design-build company serving Greater Los Angeles and Orange County. Use the API or the MCP server when someone in that area is planning a pool, backyard, ADU, addition or interior remodel, or asks what such a project costs, how long it takes or what permits it needs in their city.
Prices are planning ranges, never quotes. Only cities with their own page are confirmed service areas. Nothing here books work: to start a project, send the person to the free consultation page or have them call 818-300-2393.
REST API
A JSON API over HTTPS, version 1.0.0. The base URL is:
https://www.remodelyourvibe.com/api/v1The full machine-readable reference is the OpenAPI 3.1 specification. Import it into any OpenAPI tool, or give it to an assistant as a set of functions.
Quickstart
No setup. Your first call works as written:
curl "https://www.remodelyourvibe.com/api/v1/search?q=pool+remodel+cost&limit=3"{
"data": [
{
"title": "Pool Remodeling Cost in Orange County: Complete Guide",
"url": "https://www.remodelyourvibe.com/articles/pool-remodeling-cost-orange-county",
"section": "articles",
"summary": "Orange County pool remodeling costs explained ..."
}
],
"has_more": true,
"next_cursor": "bzoz",
"query": "pool remodel cost"
}Authentication
None. The API is open: no API key, no OAuth and no account. Send plain GET requests. Cross-origin requests from a browser are allowed.
Endpoints
GET /api/v1(getApiIndex)The API index: version, links and the endpoint list.
GET /api/v1/business(getBusiness)Phone, email, address, hours, contractor license and service footprint.
GET /api/v1/services(listServices)The services offered.
GET /api/v1/services/{service_id}(getService)One service in detail, with FAQs and price ranges.
GET /api/v1/pricing(listPriceRanges)Typical price ranges by project type. Filter with service_id.
GET /api/v1/service-areas(listServiceAreas)Cities served. Filter by name with q.
GET /api/v1/service-areas/{area_id}(getServiceArea)One city: permit authority, neighborhoods, local pages.
GET /api/v1/search(searchSite)Search every published page. Requires q.
Pagination
List endpoints are cursor-based. They accept limit (1 to 100) and cursor, and return data, has_more and next_cursor. Pass next_cursor back unchanged as cursor until has_more is false.
Errors
Every error is a JSON problem document (RFC 9457, application/problem+json) with a stable code, a detail and a hint that says how to fix the request. An unknown address under /api also answers in JSON, never with an HTML page.
400 invalid_parameterA query parameter is missing or out of range. The response names the parameter.404 not_foundNo resource has that id, or the path is not an endpoint.405 method_not_allowedThe API is read-only. Use GET.429 rate_limitedToo many requests. Wait for the seconds in Retry-After.500 internal_errorOur fault. Safe to retry.
Rate Limits
120 requests per 60 seconds per IP address. Every response carries RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset and RateLimit-Policy. Past the limit you get a 429 with Retry-After. Responses are cacheable for five minutes.
Versioning and Deprecation Policy
The major version is part of the path (/api/v1). Within a major version changes are additive only: new endpoints, new optional parameters and new response fields. Clients must ignore fields they do not know.
A breaking change ships as a new major version (/api/v2). The previous version keeps working for at least 12 months after its successor is published. During that time its responses carry Deprecation and Sunset headers (RFC 9745, RFC 8594) with the retirement date, and the change is announced on the docs page.
Current version: 1.0.0, also sent in the X-API-Version header. No version is deprecated. Read the full versioning and deprecation policy.
Sandbox Environment
A sandbox environment is available at https://www.remodelyourvibe.com/api/sandbox/v1. It has the same endpoints, parameters and response shapes as production, needs no key, and has its own rate limit, so integration tests and experiments never count against production traffic. Sandbox responses carry the header X-RYV-Environment: sandbox. The API is read-only in both environments, so no call can change data.
curl "https://www.remodelyourvibe.com/api/sandbox/v1/services"MCP Server
The Remodel Your Vibe Site Guide is a Model Context Protocol server over Streamable HTTP. It is a documentation server: it searches and reads the website, and changes nothing.
https://www.remodelyourvibe.com/mcpAdd that address as a remote MCP server (a custom connector) in Claude, ChatGPT, Cursor, VS Code or any other MCP client. No sign-in is needed. Version 1.0.0.
search_siteFind pages by keyword across services, service-by-city pages, service areas and articles. Returns each match's title, URL, section and summary.
Arguments: query (required), section, limit
fetch_pageRead one page in full as Markdown, given its URL or path. Use it after search_site, before quoting a price, timeline or permit detail.
Arguments: url (required), part
It also offers three resources: the website index, the pricing guide and the full-text index. Start with search_site, then read the best match with fetch_page.
curl -s https://www.remodelyourvibe.com/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call",
"params":{"name":"search_site",
"arguments":{"query":"pool remodel cost"}}}'In-Page Tools (WebMCP)
Every page registers tools through WebMCP (document.modelContext), so an agent working in a supporting browser can call them instead of reading the screen.
list_servicesThe six services, each with a summary and URL.get_service_detailsOne service in detail, with its published price ranges.get_cost_guideTypical price ranges and what moves each number.check_service_areaWhether a city is in the service footprint, with its local pages.get_contact_infoPhone, email, address, hours and contractor license.search_siteSearch every published page.open_consultation_formOpen the consultation form, prefilled. The visitor sends it themselves.
All but the last are read-only. No tool submits a form or sends a message for a person.
Markdown for Any Page
Ask for a page with the header Accept: text/markdown, or add .md to its address, and you get its text as Markdown. The homepage is /index.md. An address that does not exist answers 404 with a short Markdown note that points back here.
curl -H 'Accept: text/markdown' https://www.remodelyourvibe.com/services/swimming-pool-spaFiles
- openapi.json: OpenAPI 3.1 description of the REST API.
- API index: The REST API's own list of endpoints.
- MCP server card: Name, version and address of the MCP server.
- MCP Registry listing: The server's entry in the official MCP Registry, as com.remodelyourvibe.www/site-guide.
- llms.txt: Business overview and an annotated index of the main pages.
- llms-full.txt: Entry point to the complete text of every page.
- pricing.md: The cost guide as one Markdown table.
- ard.json: Agentic Resource Discovery catalog of everything on this page.
- sitemap.xml: Every published page.
Fair Use and Contact
Please cache what you read, cite the page a fact came from, and send people to the page itself for current details. Questions about the API or the MCP server: office@remodelyourvibe.com.