> ## 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.

# Set individual user groups' AI credit limits

> <Note>
  **Organization Admin** permissions are required to use this endpoint.
</Note>

Set individual AI credit limits for user groups in bulk. Each entry names a user group and either sets an individual limit or removes one so the user group follows the organization's user group default. All entries are applied in a single transaction.

A user group's limit applies to each member individually.


> [!TIP]
>
> To set an unlimited override for a user group, use `creditLimit: null`. This is distinct from having the user group follow the organization's user group default.


## OpenAPI

````yaml /api/openapi.yaml patch /v1/ai/credit-controls/user-groups
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: App downloads
    description: Download apps as PNG, PDF, XLSX, or CSV files
  - name: Branches
    description: List branches and open or close them to Viewers and Restricted Queriers
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: IP Allowlist
    description: Manage the organization's IP allowlist
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Color Palettes
    description: Manage custom chart color palettes
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder favorites
    description: Favorite and unfavorite folders
  - name: Folder labels
    description: Apply and manage labels on folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v1/ai/credit-controls/user-groups:
    patch:
      tags:
        - AI Credit Controls
      summary: Set individual user groups' AI credit limits
      description: >
        <Note>
          **Organization Admin** permissions are required to use this endpoint.
        </Note>


        Set individual AI credit limits for user groups in bulk. Each entry
        names a user group and either sets an individual limit or removes one so
        the user group follows the organization's user group default. All
        entries are applied in a single transaction.


        A user group's limit applies to each member individually.
      operationId: aiCreditControlsUserGroupsUpdate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - userGroups
              additionalProperties: false
              properties:
                userGroups:
                  type: array
                  minItems: 1
                  maxItems: 1000
                  description: >
                    User groups to update. Each entry has a `userGroupId` plus
                    exactly one of `creditLimit` (number or `null`) or
                    `useDefaultLimit: true`.
                  items:
                    type: object
                    required:
                      - userGroupId
                    additionalProperties: false
                    properties:
                      creditLimit:
                        type: number
                        nullable: true
                        minimum: 0
                        description: >-
                          The user group's individual per-member AI credit limit
                          for the billing period, or `null` for unlimited.
                          Overrides the organization's user group default.
                          Mutually exclusive with `useDefaultLimit`.
                        example: 50
                      useDefaultLimit:
                        type: boolean
                        enum:
                          - true
                        description: >-
                          Removes the user group's individual limit so it
                          follows the organization's user group default.
                          Mutually exclusive with `creditLimit`.
                      userGroupId:
                        type: string
                        description: >-
                          The user group's ID. Use the [List user
                          groups](/api/user-groups/list-user-groups) endpoint to
                          retrieve user group IDs.
                        example: mEhXj6ZI
            examples:
              Set limits for 2 user groups:
                summary: Set limits for two user groups
                value:
                  userGroups:
                    - userGroupId: mEhXj6ZI
                      creditLimit: 50
                    - userGroupId: 4KdWv8Rn
                      creditLimit: null
              Remove individual limit:
                summary: Remove individual limit
                value:
                  userGroups:
                    - userGroupId: mEhXj6ZI
                      useDefaultLimit: true
      responses:
        '200':
          description: >-
            All entries applied. Returns each user group's effective limit, in
            request order.
          content:
            application/json:
              schema:
                type: object
                required:
                  - userGroups
                properties:
                  userGroups:
                    type: array
                    items:
                      type: object
                      required:
                        - creditLimit
                        - name
                        - userGroupId
                        - usesDefaultLimit
                      properties:
                        creditLimit:
                          type: number
                          nullable: true
                          minimum: 0
                          description: >-
                            The user group's effective per-member AI credit
                            limit, or `null` for unlimited.
                          example: 50
                        name:
                          type: string
                          description: The user group's name.
                          example: Blob Sales
                        userGroupId:
                          type: string
                          description: The user group's ID.
                          example: mEhXj6ZI
                        usesDefaultLimit:
                          type: boolean
                          description: >
                            If `true`, the user group has no individual limit
                            and follows the organization's user group default.
        '400':
          description: |
            Invalid request. Common causes:

            - An empty `userGroups` array
            - More than 1000 entries
            - An entry with both `creditLimit` and `useDefaultLimit`, or neither
            - A negative `creditLimit`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError400'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
        '403':
          description: >-
            Insufficient permissions, or credit controls editing is disabled for
            the organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
        '404':
          description: >-
            A `userGroupId` is unknown, belongs to another organization, or is
            an embed entity group's ID; the response names the first invalid ID
            in request order. No limits are changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError404'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ApiError400:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 400
      required:
        - detail
        - status
    ApiError401:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
          example: 'Unauthorized: Missing or invalid API key'
        status:
          type: integer
          description: HTTP status code of the error.
          example: 401
      required:
        - detail
        - status
    ApiError403:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 403
      required:
        - detail
        - status
    ApiError404:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 404
      required:
        - detail
        - status
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#token-types).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.