> ## 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.
# Update AI credit controls
>
**Organization Admin** permissions are required for this endpoint.
Update the organization's AI credit thresholds.
At least one field is required:
- Omit a field to leave the control unchanged
- Send `null` to turn off the specified control
- Send a non-negative number to set the specified control
## OpenAPI
````yaml /api/openapi.yaml patch /v1/ai/credit-controls
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 Eval
description: >-
AI evaluation: 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 AI Routines: schedule recurring AI-powered tasks to 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 an organization. Labels can be applied to documents and
folders to help organize and categorize content.
**Label types:**
- **Basic labels**: Can be created and managed by any user
- **Verified labels**: Indicate curated or officially sanctioned content.
Admin-only.
- **Homepage labels**: Appear on the organization homepage. Admin-only.
- 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-controls:
patch:
tags:
- AI Credit Controls
summary: Update AI credit controls
description: |
**Organization Admin** permissions are required for this endpoint.
Update the organization's AI credit thresholds.
At least one field is required:
- Omit a field to leave the control unchanged
- Send `null` to turn off the specified control
- Send a non-negative number to set the specified control
operationId: aiCreditControlsUpdate
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
downgradeCredits:
type: number
nullable: true
minimum: 0
description: >
Credit usage at which AI downgrades to a cheaper model. Omit
to leave unchanged, `null` to turn off, or a non-negative
number to set.
This value must be less than or equal to `shutoffCredits`.
Omni checks this after your changes are applied on top of
the current settings. This means that a single-field update
can be rejected if it would violate that relationship.
example: 800
shutoffCredits:
type: number
nullable: true
minimum: 0
description: >-
Credit usage at which AI shuts off entirely. Omit to leave
unchanged, `null` to turn off, or a non-negative number to
set.
example: 1200
responses:
'200':
description: Thresholds updated. Returns the full current state.
content:
application/json:
schema:
$ref: f9c11d93-77c3-4e60-b801-cf37e1776347
'400':
description: |
Invalid request. Possible causes:
- Empty body
- A negative threshold
- An unknown field
- `downgradeCredits` value is higher than above `shutoffCredits`
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.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError403'
'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.
example: 'Bad Request: prompt: Required'
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.
example: 'Forbidden: AI query generation is not enabled for this organization'
status:
type: integer
description: HTTP status code of the error.
example: 403
required:
- detail
- status
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
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#personal-access-tokens-pat).
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`
````