Grihafy API
The Grihafy API analyzes a floor plan image and returns a structured report: an overall score, a verdict for each room, findings and recommended changes. The analysis follows Vastu Shastra, a traditional Indian system of guidelines for the layout and orientation of buildings. You do not need to know Vastu to integrate: you send an image and read JSON.
The Grihafy API is available to organizations only. Individual accounts cannot create API keys. To get an organization account, contact us. We create the organization and add credits; you then create your own API keys.
Deciding whether the API fits your business? Read what the Enterprise API can do for consultants, developers and proptech teams.
How it works
- 1
Get a test key
Your organization owner or admin creates it in organization settings.
- 2
Submit a floor plan
Send the image. The API replies immediately with an analysis ID.
- 3
Wait for the result
Poll the analysis or receive a webhook when it finishes.
- 4
Answer review steps
If the analysis pauses to confirm something, send your answer.
Every analysis is asynchronous. Submitting returns 202 Accepted with an analysis in the queued status; you then read it until it reaches completed, failed or expired.
Key terms
- Organization
- A company account on Grihafy. API keys, credits and webhooks belong to the organization, not to a person.
- API key
- A secret that identifies your organization on every request. Test keys start with gfy_test_ and live keys with gfy_live_.
- Analysis
- One floor plan image processed by Grihafy. It takes time, so you create it, then read it later until it finishes.
- Credit
- The unit live analyses are paid with. One live analysis uses one credit. Test keys never use credits.
- Review step
- A pause where Grihafy asks you to confirm something it is unsure about, such as which way north points.
What you need
- An organization account. See Getting access.
- A test key to build and test your integration. Test keys are free and need no credits.
- Credits and a live key before production. See Going live.
Where to go next
- Quickstart: submit a sample floor plan and read the result in a few minutes.
- Credits and Review flows: the two ideas that shape most integrations.
- Webhooks: get notified instead of polling.
- FAQ: quick answers to common questions.
- API reference: every endpoint, field and response.
Machine-readable spec
The base URL is https://api.grihafy.com/v1. The complete OpenAPI 3.1 description is at https://api.grihafy.com/v1/openapi.json. Use it with code generators and AI coding agents.