Get Started
Authentication
Authentication models used across Steve's HTTP APIs.
Steve uses three distinct authentication models.
1. API keys for external integrations
The external integration API expects:
Characteristics
- Keys are generated by a
super_adminin the admin panel underConfiguration -> API Access. - The plaintext key is shown once at creation time and is never stored server-side.
- Steve stores only
SHA-256(plaintextKey)in theapiKeystable. - Revoked keys return
403 Forbidden. - Unknown or malformed keys return
401 Unauthorized. lastUsedAtis updated asynchronously after successful authentication.
Rotation pattern
- Generate a second key.
- Roll your integration to the new key.
- Confirm traffic has moved.
- Revoke the old key.
2. Invitation tokens for onboarding
The invitation flow is capability-based rather than session-based:
GET /api/invitation/validate?token=...POST /api/invitation/complete
Characteristics
- Tokens are single-use.
- Tokens expire after 72 hours.
completerequires a password with a minimum length of 8 characters.- Invalid, expired, and consumed invitations are reported deterministically.
This surface is designed for browser onboarding, so it does not use API keys or Convex session tokens.
3. Convex session bearer tokens for the workflow agent
The private workflow agent endpoint expects a Convex Auth session token:
Characteristics
- The caller must already be authenticated through Convex Auth.
- The caller must be an admin user with the
super_adminrole. - Non-admin or non-super-admin callers receive
403. - Unauthenticated callers receive
401.
Security guidance
- Treat API keys as server-side secrets; do not embed them in browser bundles or mobile apps.
- Rotate API keys proactively rather than waiting for incident response.
- Keep invitation tokens out of logs and analytics payloads.
- For webhook consumers, verify
X-Webhook-Signaturebefore acting on payloads.