> For the complete documentation index, see [llms.txt](https://api.homedesigns.ai/homedesignsai-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.homedesigns.ai/homedesignsai-api-documentation/api-reference.md).
# API Reference
## Base URL
HomeDesignsAI APIs endpoint is:
>
The Base URL is the root URL under which all the API endpoints reside. API users should use this URL when making API calls.
{% hint style="success" %}
Our updated version of [APIs V2.0](https://homedesigns.ai/api) is now live. We advise all our new and existing API clients to migrate to the latest version of the APIs.
{% endhint %}
## API Access
To gain access to the HomeDesignsAI APIs, create an account on the [Home Design AI](https://homedesigns.ai/) and purchase the API Plan from [HomeDesigns API Plan](https://homedesigns.ai/api) page.
## API Endpoints
Here is a list of different API endpoints that you can use to integrate with your website and mobile app in order to provide an AI experience to your customers.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://api.homedesigns.ai/homedesignsai-api-documentation/api-reference.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.