Skip to main content
Use API key authentication for these operations. A signed-in integration can also use Firebase authentication to create its first API key.

Read the current account

getUserByPrivateId returns the account identified by the request credential. Call it without arguments and select only the fields your application needs.
CurrentAccount
creditBalances groups balances by common and ultraS. A balance in one category does not imply that it can pay for every generation. maxTaskCount is the account’s concurrency limit; -1 means unlimited. Review credits and billing before paid work.

Create an API key

CreateApiKey
Variables
For a Date input, use a timestamp with an explicit UTC suffix, such as 2027-01-01T00:00:00Z. Returned Date values use yyyy-MM-dd HH:mm:ss and represent UTC even though the output string has no timezone suffix. The complete secret appears in plaintextKey only in the creation response. Store it securely immediately. Listings contain metadata rather than the secret. API-key access must be enabled for the account. The account can have at most 10 active keys; handle a rejected creation rather than automatically creating more keys.
Use the new key as a Bearer credential for /graphql. API key calls do not require a Firebase ID token. Firebase login remains available for signed-in integrations, including initial key creation.

List key metadata

ListApiKeys

Revoke a key

RevokeApiKey
Variables
Only the owning account can revoke the key. Revoking an already revoked owned key is a no-op. If a creation response is lost, inspect key metadata and revoke the unwanted key before creating a replacement; the plaintext cannot be read back from the listing.