Requirements
Anentity parameter must be provided in the generated URL for this parameter to have an effect. If entityAiCreditLimit is provided without an entity, the login will fail with a missing-entity error.
Syntax
Properties
number | string
Sets an AI credit limit for the entity group at login. Accepted values:
- A whole number to set a credit cap (e.g.,
40) - The string
"unlimited"to explicitly remove any credit cap - Omit the parameter to remove the override and fall back to the organization’s embed entity group default
Examples
- Set a credit limit
- Unlimited credits
- Remove credit limit
Set
entityAiCreditLimit to a number to cap the entity group’s AI credit usage:Next steps
- Managing AI credits for embed entity groups — Learn about entity group credit limits, defaults, and monitoring
- Managing AI credit usage - Learn about organization and user-level credit limits defaults