APIClaw Caching API

openapi: 3.2.0
info:
  title: LiteLLM Caching API
  description: 'Proxy Server to call 100+ LLMs in the OpenAI format. **Customize Swagger Docs**


    👉 ```LiteLLM Admin Panel on /ui```. Create, Edit Keys with SSO. Having issues? Try ```Fallback Login```


    💸 ```LiteLLM Model Cost Map```.


    🔎 ```LiteLLM Model Hub```. See available models on the proxy. **Docs**'
  version: 1.102.1
tags:
- name: Caching
paths:
  /cache/ping:
    get:
      tags:
      - Caching
      summary: Cache Ping
      description: Endpoint for checking if cache can be pinged
      operationId: cache_ping_cache_ping_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CachePingResponse'
      security:
      - APIKeyHeader: []
  /cache/delete:
    post:
      tags:
      - Caching
      summary: Cache Delete
      description: 'Endpoint for deleting a key from the cache. All responses from litellm proxy have `x-litellm-cache-key` in the headers


        Parameters:

        - **keys**: *Optional[List[str]]* - A list of keys to delete from the cache. Example {"keys": ["key1", "key2"]}


        ```shell

        curl -X POST "http://0.0.0.0:4000/cache/delete" -H "Authorization: Bearer sk-1234" -d ''{"keys": ["key1", "key2"]}''

        ```'
      operationId: cache_delete_cache_delete_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
  /cache/redis/info:
    get:
      tags:
      - Caching
      summary: Cache Redis Info
      description: Endpoint for getting /redis/info
      operationId: cache_redis_info_cache_redis_info_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
  /cache/flushall:
    post:
      tags:
      - Caching
      summary: Cache Flushall
      description: 'A function to flush all items from the cache. (All items will be deleted from the cache with this)

        Raises HTTPException if the cache is not initialized or if the cache type does not support flushing.

        Returns a dictionary with the status of the operation.


        Usage:

        ```

        curl -X POST http://0.0.0.0:4000/cache/flushall -H "Authorization: Bearer sk-1234"

        ```'
      operationId: cache_flushall_cache_flushall_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
components:
  schemas:
    CachePingResponse:
      properties:
        status:
          type: string
          title: Status
        cache_type:
          type: string
          title: Cache Type
        ping_response:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Ping Response
        set_cache_response:
          anyOf:
          - type: string
          - type: 'null'
          title: Set Cache Response
        litellm_cache_params:
          anyOf:
          - type: string
          - type: 'null'
          title: Litellm Cache Params
        health_check_cache_params:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Health Check Cache Params
      type: object
      required:
      - status
      - cache_type
      title: CachePingResponse
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Bearer token
      in: header
      name: x-litellm-api-key