Zira logo
AI plugins
Developers
Browse Guides
How-To Guides
1 min read
Updated November 15, 2026

Generate an API Key

Create an application key for integrations and copy it during creation before closing the dialog.

API Keys
Applications
Integrations

Use this guide when you need a new application key for an integration or external client.

Choose where to create it
  • Company page: the key covers every site of the company, including sites added later. Use this for company-wide reporting or data warehouse pulls.
  • Site page: the key covers that one site.

Only company or site admins can create keys there.

Create the key from the UI
  1. Open the company or site channel. From a site, click the company name at the top to open the company page.
  2. Open the Applications tab (in the more menu next to the tabs).
  3. Click the add action.
  4. Enter a name and an optional description.
  5. Choose Access:
    • Read-only lets the key read data sources and readings but change nothing. It is the default on the company page and the right choice for reporting.
    • Full access also lets it write, for example to post readings from a custom data source. It is the default on a site page.
  6. Generate the API key.
  7. Copy the key before closing the dialog. It is shown only once.
Important notes
  • The key is typically shown at creation time, so copy it immediately.
  • Use a clear name so other developers know what the key is for.
  • Remove unused keys to reduce clutter and risk. Deleting an application stops its key within a few minutes.
  • A new key can take a few minutes to start working.
  • Keys do not expire. Rate limits apply per key; calls over the limit get HTTP 429.
Suggested usage
  • Store the key in your team’s secret manager.
  • Do not hardcode it in frontend code or commit it to the repository.

Generate API key flow


More developer docs
Previous doc
Files, Uploads, and Export

Reference the file lookup, signed-upload, import, and export endpoints used by SDK-driven file and reading flows.

Open doc