Skip to main content

Serenity Star account

A Serenity Star account gives you direct access to Serenity Edge: you create API keys, buy prepaid credits and see your usage, all from the same place. Serenity Star also handles authentication and billing for this traffic, in the EU.

Set up​

  1. Sign in to Serenity Star, or create an account.
  2. Open the API keys section and create a key for Serenity Edge. Copy it once; it is not shown again.
  3. Add prepaid credits. Usage is deducted from the balance at the published prices.
  4. Send your first request following Getting started, with base_url set to https://api.serenityedge.ai/v1.
Preview

Self-service key creation and credit top-up for Serenity Edge inside Serenity Star are being rolled out. Until they are available to every account, write to [email protected] to get a key and an initial credit balance.

Credits and billing​

  • Credits are prepaid and non-transferable. Consumption is metered on the usage object of each response.
  • When the balance reaches zero, requests fail with HTTP 429 and code: "insufficient_credits" until you top up. See Errors and rate limits.
  • Invoices are issued by Serenity Star in the EU. Authentication and billing data are processed in Azure France Central; see Data residency.

Keys​

  • Create one key per application or environment so you can rotate or revoke them independently.
  • Keys carry the default rate limits of the account. Limits grow with usage; write to [email protected] if you need more sooner.
  • Revoke a key immediately if it leaks. Requests with a revoked key return HTTP 401.