> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# entityAiCreditLimit

> Sets an AI credit limit for the embed user's entity group at login.

Sets an AI credit limit for the embed user's entity group at login.

## Requirements

An [`entity`](/embed/setup/url-parameters/entity) 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

```markdown theme={null}
entityAiCreditLimit=<value>
```

## Properties

<ParamField path="entityAiCreditLimit" type="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](/embed/admin/ai-credits#embed-entity-default)
</ParamField>

## Examples

<Tabs>
  <Tab title="Set a credit limit">
    Set `entityAiCreditLimit` to a number to cap the entity group's AI credit usage:

    ```markdown theme={null}
    entityAiCreditLimit=50
    ```
  </Tab>

  <Tab title="Unlimited credits">
    Set `entityAiCreditLimit` to `unlimited` to allow the entity group to use unlimited credits:

    ```markdown theme={null}
    entityAiCreditLimit=unlimited
    ```
  </Tab>

  <Tab title="Remove credit limit">
    To remove an entity group's credit limit override, omit the `entityAiCreditLimit` parameter from the embed URL. This will remove the group-specific setting and apply the [organization's embed entity group default](/embed/admin/ai-credits#embed-entity-default) instead.
  </Tab>
</Tabs>

## Next steps

* [Managing AI credits for embed entity groups](/embed/admin/ai-credits) — Learn about entity group credit limits, defaults, and monitoring
* [Managing AI credit usage](/ai/settings/usage) - Learn about organization and user-level credit limits defaults