openapi: 3.2.0
info:
  title: LiteLLM APIClaw Announcements 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: APIClaw Announcements
paths:
  /apiclaw/announcements:
    get:
      tags:
      - APIClaw Announcements
      summary: List Announcements
      operationId: list_announcements_apiclaw_announcements_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/_AnnouncementOut'
                type: array
                title: Response List Announcements Apiclaw Announcements Get
      security:
      - APIKeyHeader: []
    post:
      tags:
      - APIClaw Announcements
      summary: Create Announcement
      operationId: create_announcement_apiclaw_announcements_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/_CreateAnnouncementRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_AnnouncementOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /apiclaw/announcements/{announcement_id}/read:
    post:
      tags:
      - APIClaw Announcements
      summary: Mark Announcement Read
      operationId: mark_announcement_read_apiclaw_announcements__announcement_id__read_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: announcement_id
        in: path
        required: true
        schema:
          type: string
          title: Announcement Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_OkOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /apiclaw/announcements/{announcement_id}:
    delete:
      tags:
      - APIClaw Announcements
      summary: Delete Announcement
      operationId: delete_announcement_apiclaw_announcements__announcement_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: announcement_id
        in: path
        required: true
        schema:
          type: string
          title: Announcement Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_OkOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    _AnnouncementOut:
      properties:
        id:
          type: string
          title: Id
        title:
          type: string
          title: Title
        body:
          type: string
          title: Body
        link_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Link Url
        link_label:
          anyOf:
          - type: string
          - type: 'null'
          title: Link Label
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          title: Created At
        expires_at:
          type: string
          title: Expires At
        read:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Read
      type: object
      required:
      - id
      - title
      - body
      - link_url
      - link_label
      - created_by
      - created_at
      - expires_at
      title: _AnnouncementOut
    _OkOut:
      properties:
        ok:
          type: boolean
          title: Ok
      type: object
      required:
      - ok
      title: _OkOut
    _CreateAnnouncementRequest:
      properties:
        title:
          type: string
          title: Title
        body:
          type: string
          title: Body
        link_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Link Url
        link_label:
          anyOf:
          - type: string
          - type: 'null'
          title: Link Label
      type: object
      required:
      - title
      - body
      title: _CreateAnnouncementRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Bearer token
      in: header
      name: x-litellm-api-key