Skip to main content
Use sandbox keys for development, CI and acceptance tests. Sandbox responses contain synthetic data and use the same identifiers, scopes, errors and rate-limit headers as the API definition.

​
Test safely

  • Keep the key in CI secrets.
  • Use only synthetic names, contacts and records.
  • Assert on identifiers and status, not display copy.
  • Exercise 400, 401, 403, 404, 429 and 503 handling.
  • Retry only when the response permits it.

​
API compatibility

Additive fields may appear without a new API version. Ignore fields your integration does not use and keep a default branch for enum values. The Changelog records API changes. The Versioning guide defines compatibility.

​
Public research tools

Use the Heyrafiki Lab for browser-based examples. The Affective Dynamics guide connects the interactive example to its public protocol and synthetic failure cases.
Last modified on August 20, 2026