FAQ
Quick answers to the questions integrators ask most.
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.
Access and cost
Who can use the API?
Organizations only. Individual accounts cannot create API keys. See Getting access.
How do I get an organization account and API keys?
Contact us. We create the organization and add credits. The owner or an admin then creates test and live keys in organization settings.
What does an analysis cost?
One credit per live analysis. Test keys are free. See Credits. We do not publish prices in the docs.
Am I charged if an analysis fails?
No. A failed or expired analysis returns its credit, and a rejected upload never holds one. A completed analysis uses its credit even if you delete it later.
Can I buy credits myself?
Not yet. Credits are added to your organization by Grihafy.
Images and results
Which images work?
JPEG, PNG or WebP up to 10 MB, one floor plan per request. Large images are resized. See the image rules in Analyses.
Can I send a PDF, or many plans in one request?
No. Only images are supported, one per request. Export PDF pages as images and submit each one.
What if Grihafy cannot find north in my floor plan?
It depends on reviewMode. Send northAngle if you know it, use north_if_low_confidence to be asked, or auto to finish anyway with unknown directions. See Review flows.
Can I get the report in Hindi or Arabic?
Yes. Send locale as hi or ar. See the translation section of Analyses.
How do I show the report to my customer?
Use the data in result in your own interface, or give them links.share, a link you can share with people outside your organization.
How long are images and links kept?
An analysis is kept until you delete it with DELETE /v1/analyses/{id}. The image link in a response expires after about 15 minutes; read the analysis again for a new one.
Timing and reliability
How long does an analysis take?
There is no published guarantee. Do not hold a connection open. Use a webhook or check the analysis every 5 to 10 seconds. A test key finishes in about 15 seconds.
Is there an SLA or a status page?
Not yet. Build your integration to wait and retry.
What should I do after a timeout?
Retry the same request with the same Idempotency-Key. See Idempotency.
How do I get help with a failed request?
Contact us with the requestId from the error response, or the analysis ID.
Integration
Polling or webhooks?
Either works. Webhooks avoid repeated requests and arrive when the analysis changes; see Webhooks. Polling is simpler to start with.
Do test and live keys use the same webhook endpoint?
Yes. Each organization has one endpoint. Check livemode in the event.
Are there SDKs?
Not yet. The API is plain HTTP and JSON. Generate a client from the OpenAPI spec if you want one.
Will the API change?
Changes inside version 1 are additive: new optional fields and new values where documented. A breaking change would use a new version in the URL, with advance notice.