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

# Chatbot Avatar

> Chatbot Avatar



## OpenAPI

````yaml api-reference/openapi-spec.json patch /api/external/chatbot/{chatbotId}/update-avatar
openapi: 3.0.3
info:
  title: OKCHAT2.0
  version: 1.0.0
  contact: {}
servers:
  - url: https://v2.okchat.ai
  - url: http://localhost
security: []
tags: []
paths:
  /api/external/chatbot/{chatbotId}/update-avatar:
    parameters:
      - name: chatbotId
        in: path
        required: true
        schema:
          type: string
          example: 3317853e-0af2-427d-a56f-351a9587f48f
    patch:
      summary: Chatbot Avatar
      description: Chatbot Avatar
      operationId: chatbotAvatar
      parameters:
        - name: x-api-key
          in: header
          schema:
            type: string
            example: 15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                avatar:
                  type: string
                  format: binary
      responses:
        '200':
          description: Chatbot Avatar
          headers:
            CF-RAY:
              schema:
                type: string
                example: 905cd3267d4c87ad-SIN
            Cache-Control:
              schema:
                type: string
                example: public, max-age=0, must-revalidate
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: br
            Date:
              schema:
                type: string
                example: Wed, 22 Jan 2025 04:33:18 GMT
            NEL:
              schema:
                type: string
                example: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
            Report-To:
              schema:
                type: string
                example: >-
                  {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=QYJ7RA3d%2B7Wzw4tmyeDttJ78%2BFgMzzDZl1q1SchZjNmkGWPgJZWjokL82Gdilk2zaVhOzSNNw%2Flhq3gJtmIvYK0HW56mdFdD231y0c7r8Kzk3GN6q2O8xtplOXjX3hM%3D"}],"group":"cf-nel","max_age":604800}
            Server:
              schema:
                type: string
                example: cloudflare
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            access-control-allow-credentials:
              schema:
                type: string
                example: 'true'
            access-control-allow-headers:
              schema:
                type: string
                example: >-
                  X-CSRF-Token, X-Requested-With, Accept, Accept-Version,
                  Content-Length, Content-MD5, Content-Type, Date, X-Api-Version
            access-control-allow-methods:
              schema:
                type: string
                example: GET,OPTIONS,PATCH,DELETE,POST,PUT
            access-control-allow-origin:
              schema:
                type: string
                example: '*'
            alt-svc:
              schema:
                type: string
                example: h3=":443"; ma=86400
            cf-cache-status:
              schema:
                type: string
                example: DYNAMIC
            server-timing:
              schema:
                type: string
                example: >-
                  cfL4;desc="?proto=TCP&rtt=891&min_rtt=879&rtt_var=355&sent=107&recv=221&lost=0&retrans=0&sent_bytes=2803&recv_bytes=162239&delivery_rate=2952089&cwnd=248&unsent_bytes=0&cid=6529062143347b62&ts=3440&x=0"
            strict-transport-security:
              schema:
                type: string
                example: max-age=63072000
            vary:
              schema:
                type: string
                example: accept-encoding
            x-matched-path:
              schema:
                type: string
                example: /api/external/chatbot/[id]/update-avatar
            x-vercel-cache:
              schema:
                type: string
                example: MISS
            x-vercel-id:
              schema:
                type: string
                example: sin1::icn1::sw5z4-1737520395506-94f91c4f1d77
          content:
            application/json:
              schema:
                type: object
                properties:
                  chatbot:
                    type: object
                    properties:
                      active:
                        type: boolean
                        example: true
                      created_at:
                        type: string
                        example: '2025-01-22T04:30:45.790337+00:00'
                      description:
                        type: string
                        example: A helpful support assistant
                      docs_metadata:
                        nullable: true
                        example: null
                      enabled_plugins:
                        nullable: true
                        example: null
                      id:
                        type: string
                        example: 3317853e-0af2-427d-a56f-351a9587f48f
                      is_public:
                        type: boolean
                        example: true
                      managers:
                        nullable: true
                        example: null
                      migrated_data:
                        type: boolean
                        example: false
                      name:
                        type: string
                        example: API Docs Demo Chatbot
                      openai_api_key:
                        nullable: true
                        example: null
                      organization_id:
                        type: string
                        example: 123042b2-86e2-4184-a86e-95423d728815
                      personality_config:
                        type: object
                        properties:
                          style:
                            type: string
                            example: Friendly
                          tone:
                            type: string
                            example: Professional
                      settings:
                        type: object
                        properties:
                          avatar:
                            type: string
                            example: >-
                              https://alwiuiydhxcstgrluarg.supabase.co/storage/v1/object/public/chatbot/3317853e-0af2-427d-a56f-351a9587f48f/7b9ec849-29fb-41c4-b66e-0709e7fa18b9.jpg
                          greeting:
                            type: string
                            example: Hello! How can I assist you today?
                          isRequestUserInfoEnabled:
                            type: boolean
                            example: false
                          isToolEnabled:
                            type: boolean
                            example: true
                          model:
                            type: string
                            example: gpt-4o-mini
                          prompt:
                            type: string
                            example: >-
                              You are a highly skilled customer support
                              assistant for [company name]. Your goal is to
                              provide accurate, polite, and concise answers to
                              customer inquiries. If you do not know the answer,
                              recommend the customer to contact human support or
                              check the FAQ section. Ensure a positive tone in
                              all responses
                          snippet:
                            type: object
                            properties:
                              header:
                                type: string
                                example: Customer Support
                              logo:
                                type: string
                                example: https://example.com/logo.png
                              name:
                                type: string
                                example: Support Assistant
                              primaryColor:
                                type: string
                                example: '#4F46E5'
                              secondaryColor:
                                type: string
                                example: '#10B981'
                              slogan:
                                type: string
                                example: How can I help you today?
                      slug:
                        type: string
                        example: api-docs-demo-chatbot
                      suggestions:
                        nullable: true
                        example: null
                      updated_at:
                        type: string
                        example: '2025-01-22T04:30:45.790337+00:00'
                      v1_chatbot_id:
                        nullable: true
                        example: null
                      version_id:
                        nullable: true
                        example: null
                      voice_widget_config:
                        nullable: true
                        example: null
                  message:
                    type: string
                    example: Avatar updated successfully
              examples:
                Chatbot Avatar:
                  value:
                    chatbot:
                      active: true
                      created_at: '2025-01-22T04:30:45.790337+00:00'
                      description: A helpful support assistant
                      docs_metadata: null
                      enabled_plugins: null
                      id: 3317853e-0af2-427d-a56f-351a9587f48f
                      is_public: true
                      managers: null
                      migrated_data: false
                      name: API Docs Demo Chatbot
                      openai_api_key: null
                      organization_id: 123042b2-86e2-4184-a86e-95423d728815
                      personality_config:
                        style: Friendly
                        tone: Professional
                      settings:
                        avatar: >-
                          https://alwiuiydhxcstgrluarg.supabase.co/storage/v1/object/public/chatbot/3317853e-0af2-427d-a56f-351a9587f48f/7b9ec849-29fb-41c4-b66e-0709e7fa18b9.jpg
                        greeting: Hello! How can I assist you today?
                        isRequestUserInfoEnabled: false
                        isToolEnabled: true
                        model: gpt-4o-mini
                        prompt: >-
                          You are a highly skilled customer support assistant
                          for [company name]. Your goal is to provide accurate,
                          polite, and concise answers to customer inquiries. If
                          you do not know the answer, recommend the customer to
                          contact human support or check the FAQ section. Ensure
                          a positive tone in all responses
                        snippet:
                          header: Customer Support
                          logo: https://example.com/logo.png
                          name: Support Assistant
                          primaryColor: '#4F46E5'
                          secondaryColor: '#10B981'
                          slogan: How can I help you today?
                      slug: api-docs-demo-chatbot
                      suggestions: null
                      updated_at: '2025-01-22T04:30:45.790337+00:00'
                      v1_chatbot_id: null
                      version_id: null
                      voice_widget_config: null
                    message: Avatar updated successfully

````