openapi: 3.2.0
info:
  title: 'Mealie Groups: AI Provider Settings API'
  description: '

    Mealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful

    API interactive documentation that can be used to explore the API. If you''re justing getting started with

    the API and want to get started quickly, you can use the

    [API Usage | Mealie Docs](https://docs.mealie.io/documentation/getting-started/api-usage/)

    as a reference for how to get started.



    If you have any questions or comments about mealie, please use the discord server to talk to the developers or other

    community members. If you''d like to file an issue, please use the

    [GitHub Issue Tracker | Mealie](https://github.com/mealie-recipes/mealie/issues/new/choose)



    ## Helpful Links

    - [Home Page](https://mealie.io)

    - [Documentation](https://docs.mealie.io)

    - [Discord](https://discord.gg/QuStdQGSGK)

    - [Demo](https://demo.mealie.io)

    '
  version: nightly
tags:
- name: 'Groups: AI Provider Settings'
paths:
  /api/groups/ai-providers/settings:
    get:
      tags:
      - 'Groups: AI Provider Settings'
      summary: Get Ai Provider Settings
      operationId: get_ai_provider_settings_api_groups_ai_providers_settings_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AIProviderSettingsOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - 'Groups: AI Provider Settings'
      summary: Update Ai Provider Settings
      operationId: update_ai_provider_settings_api_groups_ai_providers_settings_put
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AIProviderSettingsUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AIProviderSettingsOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AIProviderSummary:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
      - id
      - name
      title: AIProviderSummary
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AIProviderSettingsOut:
      properties:
        defaultProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Defaultproviderid
        audioProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Audioproviderid
        imageProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Imageproviderid
        providers:
          items:
            $ref: '#/components/schemas/AIProviderSummary'
          type: array
          title: Providers
        aiEnabled:
          type: boolean
          title: Aienabled
          readOnly: true
        audioProviderEnabled:
          type: boolean
          title: Audioproviderenabled
          readOnly: true
        imageProviderEnabled:
          type: boolean
          title: Imageproviderenabled
          readOnly: true
      type: object
      required:
      - defaultProviderId
      - audioProviderId
      - imageProviderId
      - providers
      - aiEnabled
      - audioProviderEnabled
      - imageProviderEnabled
      title: AIProviderSettingsOut
    AIProviderSettingsUpdate:
      properties:
        defaultProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Defaultproviderid
        audioProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Audioproviderid
        imageProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Imageproviderid
      type: object
      required:
      - defaultProviderId
      - audioProviderId
      - imageProviderId
      title: AIProviderSettingsUpdate
    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
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/auth/token