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

# Read individual users' AI credit usage

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

List individual users' (up to 1,000 unique users per request) AI credit usage for the current billing period. Each user ID must be a member of the organization. Unknown, invalid, and duplicate IDs will fail the request.

Returns each user's credits used, in request order, plus the billing-period bounds. Users with no current usage will report `0`. 




## OpenAPI

````yaml /api/openapi.yaml post /v1/ai/credit-usage/users
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: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish. Replaces the one-shot `PUT`/`PATCH`
      v1 document write endpoints.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - 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: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content 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: 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-usage/users:
    post:
      tags:
        - AI Credit Usage
      summary: Read individual users' AI credit usage
      description: >
        <Note>
          **Organization Admin** permissions are required to use this endpoint.
        </Note>


        List individual users' (up to 1,000 unique users per request) AI credit
        usage for the current billing period. Each user ID must be a member of
        the organization. Unknown, invalid, and duplicate IDs will fail the
        request.


        Returns each user's credits used, in request order, plus the
        billing-period bounds. Users with no current usage will report `0`. 
      operationId: aiCreditUsageUsersRead
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - userIds
              additionalProperties: false
              properties:
                userIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                    example: f4a2b3c8-0d1e-4f5a-9b6c-7d8e9f0a1b2c
                  minItems: 1
                  maxItems: 1000
                  description: >
                    Users to read usage for, at most 1000 per request. Each
                    entry is a user's ID within this organization; each ID must
                    be included only once. Duplicated IDs will result in an
                    error.
      responses:
        '200':
          description: >-
            Each requested user's credit usage for the current billing period,
            in request order.
          content:
            application/json:
              schema:
                type: object
                required:
                  - periodEnd
                  - periodStart
                  - users
                properties:
                  periodEnd:
                    type: integer
                    minimum: 0
                    description: >-
                      End of the current billing period as a Unix ms timestamp
                      (UTC calendar-month boundary).
                  periodStart:
                    type: integer
                    minimum: 0
                    description: >-
                      Start of the current billing period as a Unix ms timestamp
                      (UTC calendar-month boundary).
                  users:
                    type: array
                    items:
                      type: object
                      required:
                        - creditsUsed
                        - userId
                      properties:
                        creditsUsed:
                          type: number
                          minimum: 0
                          description: >-
                            Credits the user consumed in the current billing
                            period. `0` when there is no usage yet.
                          example: 42
                        userId:
                          type: string
                          format: uuid
                          description: The user's ID within this organization.
                          example: f4a2b3c8-0d1e-4f5a-9b6c-7d8e9f0a1b2c
        '400':
          description: >
            Invalid request. Common causes: an empty `userIds` array, more than
            1000 IDs, or a duplicated `userId`.
          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 per-user AI credit limits are not
            enabled for the organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
        '404':
          description: >-
            A `userId` is not a member of the organization; the response names
            the first invalid ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError404'
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
  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`

````