REST API Authentication

Create a key in Billing → API Keys, or with peach auth key create after peach login. Every account can create keys, the free Seed plan included; you must be an account owner or admin. Work that costs money still draws on the account’s balance or plan. The complete sk_rnx_... secret appears once. Store it in your secret manager instead of source control.

Send the key as a Bearer token:

Authorization: Bearer sk_rnx_...

The session token created by peach login also authenticates /api/v1:

Authorization: Bearer <rnx-session-token>

Session tokens have all API scopes. Browser cookies alone and GitHub installation tokens do not authenticate /api/v1 requests.

For preview uploads authenticated with a session token, send x-rnx-account-id: <account-id> on both reserve and finalize. You must be a member of that account. API keys select their account automatically.

Scopes

ScopeAccess
preview_uploadCreate, finalize, and inspect previews
buildsPublish and inspect customer-built snapshots for linked repositories
test_runsRegister and list Maestro or Detox test runs
simsStart, heartbeat, stop, and list Peach cloud metering sessions
llmExisting AI-assisted preview and flow endpoints outside /api/v1

An insufficient API-key scope returns 403 insufficient_scope. An expired, revoked, or unknown key, or an invalid session token, returns 401 unauthorized.

Key lists show the prefix, creator, scopes, creation time, expiration, and last use. Revocation takes effect immediately. Create a replacement before revoking a key when rotating automation without downtime.