entity parameter in embed URL requests. You can set AI credit limits for these groups to control how much AI usage is allowed for users within each entity. This is useful when embedding Omni for multiple customers or tenants and you want to manage AI consumption on a per-entity basis.
How embed entity group limits work
Along with organization-level and user-level AI credit controls, embed entity group controls allow you to limit AI credit consumption at the entity group level. You can set group-specific limits and a default that applies to all entity groups, allowing you to control how many credits specific groups can consume. For example, you can set a higher limit for groups with more contracted usage and let other groups use the entity group default. Credit controls can be managed in the AI Hub > General > Credits tab or programmatically through the AI credit controls API.Requirements
To manage AI credit limits for embed entity groups, you’ll need:- Organization Admin permissions
- The Embed feature enabled in your Omni instance
Setting an embed entity group default
An embed entity group default applies to all entity groups. When set, the limit will act as the default for any group that doesn’t have a specific limit.- Omni UI
- API
- Navigate to AI Hub > General.
- Click the Credits tab.
- In the Embed entity settings section, enter the number of credits in the default limit field, or leave it empty to allow unlimited credits by default.
- Click Save.
Setting per-group credit limits
Each embed entity group has its own detail page where you can configure a credit limit specific to that group. When set:- The group-level limit will override the embed entity group default
- An entity group user’s usage will count against their individual user limit (if set) and their entity group’s limit
- Omni UI
- API
- Navigate to Settings > Groups.
- Click the Embed tab to display the list of embed entity groups.
- Click the embed entity group you want to manage.
- Click the Settings tab.
- Next to AI credit limit, click the Edit button.
- In the dialog that displays, configure the group’s credit limit:
- To set a cap, enter a whole number (ex:
40) in the Credit limit field - To allow unrestricted usage, click the Unlimited toggle
- To reset to the embed entity group default, click Reset to default
- To set a cap, enter a whole number (ex:
- Click Save.
Monitoring entity group credit usage
To get an entity group’s usage for the current billing period, use the Read individual entity groups’ AI credit limits endpoint and include the entity in the request body’sentities parameter:
Next steps
- Managing AI credit usage — Learn about AI credits, organization-level and user-level controls, and monitoring tools
- Managing embed users — View, manage, and impersonate users in your embedded Omni application