Getting access
The Grihafy API is available to organizations. This page explains how to get one and who in it can create API keys.
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.
How to get an organization account
- Contact us and tell us about your use case. Include the email of the person who should own the organization.
- The owner needs a Grihafy account with that email. Grihafy staff then create the organization and make that account its owner.
- For live use we add credits to the organization. See Credits. There is no self-service purchase yet.
- The owner or an admin creates API keys in organization settings. Start with a test key.
Who can do what
| Role | In the API and organization settings |
|---|---|
| Owner, admin | Create and revoke API keys, manage the webhook endpoint, change organization settings, view credit usage, and create, review and delete analyses. |
| Editor | Create analyses, answer review steps and view credit usage. Cannot delete analyses, create API keys or manage webhooks. |
| Viewer | View analyses and credit usage. Cannot create, review or delete analyses. |
An API key belongs to the organization, not to the person who created it, and keeps working if that person leaves. Every key has full access to the organization analyses and credit balance; there are no per-key permissions yet.
Where things live
In the Grihafy web app, replace your-org with your organization slug.
| Page | Use it to |
|---|---|
/org/your-org/settings/api-keys | Create, expire and revoke API keys. |
/org/your-org/settings/webhooks | Set the webhook URL, copy the signing secret, view delivery logs, resend and rotate. |
/org/your-org/settings/usage | See the credit balance, grants, and a usage history you can export as CSV. |
/org/your-org/settings/people | Manage who belongs to the organization and their roles. |
Test keys and live keys
Every organization can create both. A gfy_test_ key returns sample results and uses no credits, so you can build safely. A gfy_live_ key analyzes real floor plans and uses one credit per analysis. See Sandbox and Going live.