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

> Read one help center: its name, description, domain, logo, languages, theme, custom CSS and head scripts, and per-language title and description overrides.

# Get



## OpenAPI

````yaml get /hc/{id}
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:
  /hc/{id}:
    get:
      summary: Get a help center
      description: >-
        Read one help center: its name, description, domain, languages, theme,
        custom CSS and head scripts, and per-language title/description
        overrides.
      operationId: getHelpCenter
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicHelpCenterDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    PublicHelpCenterDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/PublicHelpCenterDto'
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
        domain:
          anyOf:
            - type: string
            - type: 'null'
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
        primary_language_code:
          type: string
        enabled_languages:
          type: array
          items:
            type: string
        auto_translate:
          type: string
          enum:
            - on_publish
            - 'off'
          description: >-
            When automatic translation into the other enabled languages runs:
            after a source-language publish, or never.
        translation_prompt:
          anyOf:
            - type: string
            - type: 'null'
        custom_css:
          anyOf:
            - type: string
            - type: 'null'
        custom_head_scripts:
          anyOf:
            - type: string
            - type: 'null'
        sidebar_variant:
          type: string
          enum:
            - sidebar
            - floating
            - inset
        theme:
          type: string
          enum:
            - default
            - thmanyah
        localizations:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: object
            properties:
              title:
                type: string
              description:
                anyOf:
                  - type: string
                  - type: 'null'
            additionalProperties: false
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - description
        - domain
        - logo_url
        - primary_language_code
        - enabled_languages
        - auto_translate
        - translation_prompt
        - custom_css
        - custom_head_scripts
        - sidebar_variant
        - theme
        - localizations
        - updated_at
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````