Skip to content
squallyDocs
Getting started

Read keys

Who creates a read key, what it can read, and when it expires.

Authentication

Section titled “Authentication”

Every request carries an organization read key as Authorization: Bearer sqly_ro_…. A read key is organization-wide (every project), created by an organization admin in Settings → API keys, and expires after 30, 60, 90, 180 days as chosen at creation. There is no renewal: create a new key and revoke the old one. Project ingest keys (sqly_…) are refused with wrong_key_type.

Expiry warning

Section titled “Expiry warning”

From 7 days before a key expires, every authenticated response carries Squally-Key-Expires-At with the expiry instant (ISO-8601).

Plans

Section titled “Plans”

The read API is part of the Standard and Pro plans. A key of an organization on Free is answered 403 tier_too_low; keys are not revoked on a downgrade and work again after an upgrade.