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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# Create a cache rule

> Matchers are ANDed across non-null fields; at least one matcher is required. Mode is one of respect/force/disable. TTL is clamped to [0, 86400]. Salt is an optional cache-bust tag (max 64 chars). All writes emit a ChangeEvent so the gateway picks up the new rule within 30 s via its /changes long-poll. Send `Idempotency-Key` to make a retry safe.



## OpenAPI

````yaml POST /api/gateway/v1/cache-rules
openapi: 3.1.0
info:
  title: LangWatch API
  version: 1.0.0
  description: LangWatch openapi spec
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/gateway/v1/cache-rules:
    post:
      tags:
        - Cache Rules
      summary: Create a cache rule
      description: >-
        Matchers are ANDed across non-null fields; at least one matcher is
        required. Mode is one of respect/force/disable. TTL is clamped to [0,
        86400]. Salt is an optional cache-bust tag (max 64 chars). All writes
        emit a ChangeEvent so the gateway picks up the new rule within 30 s via
        its /changes long-poll. Send `Idempotency-Key` to make a retry safe.
      operationId: postApiGatewayV1CacheRules
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            A caller-chosen key, 8 to 255 characters, that makes this create
            safe to retry. The first request to use a key runs normally and its
            response is stored for 24 hours. A later request with the same key
            and the same body is not executed again: it returns the stored
            response, marked with `X-Idempotent-Replay: true`. The same key with
            a different body is refused 409 `idempotency_error`, as is a retry
            sent while the original is still running. Only successful responses
            are stored, so a create that failed can simply be retried with the
            same key.
          schema:
            type: string
            minLength: 8
            maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 128
                description:
                  type:
                    - string
                    - 'null'
                  maxLength: 512
                priority:
                  type: integer
                  minimum: 0
                  maximum: 1000
                enabled:
                  type: boolean
                matchers:
                  type: object
                  properties:
                    vk_id:
                      type: string
                    vk_tags:
                      type: array
                      items:
                        type: string
                    vk_prefix:
                      type: string
                    principal_id:
                      type: string
                    model:
                      type: string
                    request_metadata:
                      type: object
                      additionalProperties:
                        type: string
                  additionalProperties: false
                action:
                  type: object
                  properties:
                    mode:
                      type: string
                      enum:
                        - respect
                        - force
                        - disable
                    ttl:
                      type: integer
                      minimum: 0
                      maximum: 86400
                    salt:
                      type: string
                      maxLength: 64
                  required:
                    - mode
                  additionalProperties: false
              required:
                - name
                - matchers
                - action
      responses:
        '201':
          description: Created
          headers:
            X-Idempotent-Replay:
              description: >-
                Present and `true` only when this body came from a stored
                response rather than a fresh execution. Absent on the first use
                of a key, and on every request that carries no key.
              schema:
                type: string
                enum:
                  - 'true'
          content:
            application/json:
              schema:
                type: object
                properties:
                  cache_rule:
                    type: object
                    properties:
                      id:
                        type: string
                      organization_id:
                        type: string
                      name:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      priority:
                        type: integer
                      enabled:
                        type: boolean
                      matchers:
                        type: object
                        additionalProperties: {}
                      action:
                        type: object
                        properties:
                          mode:
                            type: string
                            enum:
                              - respect
                              - force
                              - disable
                          ttl:
                            type: integer
                          salt:
                            type: string
                        required:
                          - mode
                      mode_enum:
                        type: string
                        enum:
                          - respect
                          - force
                          - disable
                      archived_at:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                      - id
                      - organization_id
                      - name
                      - description
                      - priority
                      - enabled
                      - matchers
                      - action
                      - mode_enum
                      - archived_at
                      - created_at
                      - updated_at
                required:
                  - cache_rule
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
                      meta:
                        type: object
                        additionalProperties: {}
                      trace_id:
                        type: string
                      span_id:
                        type: string
                    required:
                      - type
                      - code
                      - message
                required:
                  - error
      security:
        - project_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````