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

# Preview

> Get a private link to a saved revision or a temporary template preview. Teammates sign in with permission to read the selected Help Center.

Pass the optional `page` query parameter to open a localized page such as `/ar/about`, or an article section such as `/en/guide#billing`. When building the request URL by hand, encode the hash as `%23` so it reaches the API. Omit `page` to open the Help Center homepage.


## OpenAPI

````yaml get /hc/{id}/themes/{designId}/versions/{revisionId}/preview
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}/themes/{designId}/versions/{revisionId}/preview:
    get:
      summary: Get a private theme preview link
      description: >-
        Get a dashboard link to a pinned revision. Opening the link requires a
        signed-in help center reader.
      operationId: getHelpCenterThemePreview
      parameters:
        - schema:
            type: string
            maxLength: 2048
            pattern: ^\/[a-z]{2,3}(?:-[a-z0-9]{2,8})*(?:[/?#][^\\\r\n]*)?$
          in: query
          name: page
          required: false
          description: >-
            Site-relative page including its language, for example
            /en/guide#billing or /ar/search?q=billing.
        - schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          in: path
          name: id
          required: true
        - schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          in: path
          name: designId
          required: true
        - schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          in: path
          name: revisionId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HcThemePreviewLinkDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    HcThemePreviewLinkDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/HcThemePreviewLinkDto'
      type: object
      properties:
        url:
          type: string
          format: uri
      required:
        - url
      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.