> ## 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.
# Reset cache
> Resets the cache for the specified cache policy.
`cachePolicyName` values are not validated against existing policies. Verify that the values you provide are exact matches to policies in the model.
## OpenAPI
````yaml /api/openapi.yaml post /v1/models/{modelId}/cache_reset/{cachePolicyName}
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: AI
description: AI-powered query generation
- 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: Documents
description: Create, retrieve, and manage documents
- 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/models/{modelId}/cache_reset/{cachePolicyName}:
post:
tags:
- Models
summary: Reset cache
description: |
Resets the cache for the specified cache policy.
`cachePolicyName` values are not validated against existing policies. Verify that the values you provide are exact matches to policies in the model.
operationId: resetModelCache
parameters:
- name: modelId
in: path
required: true
schema:
type: string
format: uuid
description: The ID of the model associated with the cache policy.
- name: cachePolicyName
in: path
required: true
schema:
type: string
description: The name of the cache policy to reset.
requestBody:
content:
application/json:
schema:
type: object
properties:
resetAt:
type: string
format: date-time
description: >
An ISO-8601 date string that sets the time the cache should
be reset (invalidated). When set, cache entries created
between this value and the current time will still be
considered valid. Cannot be a future date. Defaults to now.
responses:
'200':
description: Cache reset successfully
content:
application/json:
schema:
type: object
properties:
cache_reset:
type: object
description: The cache reset details.
properties:
id:
type: string
format: uuid
description: ID of the cache reset record.
model_id:
type: string
format: uuid
description: ID of the model.
policy_name:
type: string
description: Name of the cache policy.
created_at:
type: string
format: date-time
description: Timestamp when the cache reset record was created.
updated_at:
type: string
format: date-time
description: >-
Timestamp when the cache reset record was last
updated.
reset_at:
type: string
format: date-time
description: Timestamp when the cache was reset.
success:
type: boolean
description: Indicates the request was successful.
'400':
description: |
Bad Request
Possible error messages:
- `Model with id does not exist`
- `resetAt cannot be future dated`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: |
Not Found
Possible error messages:
- `Model with id does not exist`
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- bearerAuth: []
components:
schemas:
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'
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`
````