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

# Get VOC settings

> Get VOC settings — Public subset of Voice-of-Customer settings (mirrors dashboard field names).



## OpenAPI

````yaml get /insights/settings
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /insights/settings:
    get:
      summary: Get VOC settings
      description: >-
        Public subset of Voice-of-Customer settings (mirrors dashboard field
        names). Currently returns only `custom_analysis_instructions` (Customer
        Insights → Settings → AI Instructions). Does not return webhooks, notify
        lists, alert/merge toggles, category-suggestion settings, or other
        internal fields.
      operationId: getVocSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicVocSettingsDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    PublicVocSettingsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/PublicVocSettingsDto'
      type: object
      properties:
        custom_analysis_instructions:
          anyOf:
            - type: string
              maxLength: 1000
            - type: 'null'
          description: >-
            Dashboard: Customer Insights → Settings → AI Instructions.
            Org-specific analysis constraints injected into the VOC insights
            analyzer for future runs. Max 1000 chars. Null means unset.
      required:
        - custom_analysis_instructions
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.