> ## 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.

# Get Chatbots

> Get Chatbots



## OpenAPI

````yaml api-reference/openapi-spec.json get /api/external/chatbots
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/chatbots:
    get:
      summary: Get Chatbots
      description: Get Chatbots
      operationId: getChatbots
      parameters:
        - name: x-api-key
          in: header
          schema:
            type: string
            example: 15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68
      responses:
        '200':
          description: Get Chatbots
          headers:
            CF-RAY:
              schema:
                type: string
                example: 905cd667bb63ce31-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:35:30 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=Qbm0hH2VHRfbSbyGdrMmDr%2FSW1zQtnwMdBblKe0JwzvFUbK%2BzNHMb0qFdV0u9W4qA0E76i6nExwdJCoXea%2FLEb5B%2FTGdyig9zkiIWUlOd9X6icQoMDzqa%2Buo0vU1IOk%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=861&min_rtt=781&rtt_var=189&sent=12&recv=13&lost=0&retrans=0&sent_bytes=5369&recv_bytes=2038&delivery_rate=4407914&cwnd=255&unsent_bytes=0&cid=099503defb4c9823&ts=44203&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/chatbots
            x-vercel-cache:
              schema:
                type: string
                example: MISS
            x-vercel-id:
              schema:
                type: string
                example: sin1::7nfql-1737520528604-ac45fa660709
          content:
            application/json:
              schema:
                type: object
                properties:
                  chatbots:
                    type: array
                    items:
                      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
                        enabled_plugins:
                          nullable: true
                          example: null
                        id:
                          type: string
                          example: 3317853e-0af2-427d-a56f-351a9587f48f
                        is_public:
                          type: boolean
                          example: false
                        name:
                          type: string
                          example: API Docs Demo Chatbot
                        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:
                            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'
                        version_id:
                          nullable: true
                          example: null
                        voice_widget_config:
                          nullable: true
                          example: null
                    example:
                      - active: true
                        created_at: '2025-01-22T04:30:45.790337+00:00'
                        description: A helpful support assistant
                        enabled_plugins: null
                        id: 3317853e-0af2-427d-a56f-351a9587f48f
                        is_public: false
                        name: API Docs Demo Chatbot
                        organization_id: 123042b2-86e2-4184-a86e-95423d728815
                        personality_config:
                          style: Friendly
                          tone: Professional
                        settings:
                          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'
                        version_id: null
                        voice_widget_config: null
              examples:
                Get Chatbots:
                  value:
                    chatbots:
                      - active: true
                        created_at: '2025-01-22T04:30:45.790337+00:00'
                        description: A helpful support assistant
                        enabled_plugins: null
                        id: 3317853e-0af2-427d-a56f-351a9587f48f
                        is_public: false
                        name: API Docs Demo Chatbot
                        organization_id: 123042b2-86e2-4184-a86e-95423d728815
                        personality_config:
                          style: Friendly
                          tone: Professional
                        settings:
                          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'
                        version_id: null
                        voice_widget_config: null

````