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

# Resolve helpdesk

> Turns the hostname the visitor arrived on into the help center that answers
for it, with its theme and support channels — the payload every SSR render
starts from.

The hostname comes from `X-Helpdesk-Host` or, for this route only, from
`?hostname=`. Resolution and its Redis cache live in the middleware; this
handler only projects the result.



## OpenAPI

````yaml /api/helpdesk.yaml get /v1/public/resolve
openapi: 3.0.3
info:
  description: >-
    Help center API for the Talqui Helpdesk plugin. Two surfaces with different
    audiences: authenticated authoring routes under /v1/tenants/:tenantID, and
    anonymous public reads under /v1/public resolved from the request hostname.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui Helpdesk API
  version: 0.9.0
servers:
  - description: Production
    url: https://plugins-api.talqui.chat/helpdesk
security: []
tags:
  - name: Install
  - name: Public
  - name: Helpdesk
  - name: Categories
  - name: Articles
paths:
  /v1/public/resolve:
    get:
      tags:
        - Public
      summary: Resolve helpdesk
      description: >-
        Turns the hostname the visitor arrived on into the help center that
        answers

        for it, with its theme and support channels — the payload every SSR
        render

        starts from.


        The hostname comes from `X-Helpdesk-Host` or, for this route only, from

        `?hostname=`. Resolution and its Redis cache live in the middleware;
        this

        handler only projects the result.
      operationId: ResolveHelpdeskController
      parameters:
        - in: query
          name: hostname
          required: false
          schema:
            maxLength: 253
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  helpdesk:
                    additionalProperties: false
                    nullable: true
                    properties:
                      helpdeskHostnames:
                        items:
                          type: string
                        type: array
                      helpdeskID:
                        type: string
                      helpdeskLocale:
                        type: string
                      helpdeskName:
                        type: string
                      helpdeskSlug:
                        nullable: true
                        type: string
                      helpdeskStatus:
                        enum:
                          - draft
                          - published
                        type: string
                      helpdeskSupport:
                        additionalProperties: false
                        properties:
                          chatEnabled:
                            type: boolean
                          emailAddress:
                            nullable: true
                            type: string
                          websiteUrl:
                            nullable: true
                            type: string
                        required:
                          - chatEnabled
                          - emailAddress
                          - websiteUrl
                        type: object
                      helpdeskTheme:
                        additionalProperties: false
                        properties:
                          colorHeaderBackground:
                            nullable: true
                            type: string
                          colorLoading:
                            nullable: true
                            type: string
                          colorPrimary:
                            nullable: true
                            type: string
                          faviconUrl:
                            nullable: true
                            type: string
                          headerTitle:
                            nullable: true
                            type: string
                          logoUrl:
                            nullable: true
                            type: string
                        required:
                          - colorPrimary
                          - colorHeaderBackground
                          - colorLoading
                          - logoUrl
                          - faviconUrl
                          - headerTitle
                        type: object
                    required:
                      - helpdeskID
                      - helpdeskName
                      - helpdeskSlug
                      - helpdeskLocale
                      - helpdeskStatus
                      - helpdeskTheme
                      - helpdeskSupport
                      - helpdeskHostnames
                    type: object
                required:
                  - helpdesk
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/MissingHelpdeskHostnameError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingHelpdeskHostnameError (error_code 1106): no hostname on the
            request.
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/HelpdeskNotFoundError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            HelpdeskNotFoundError (error_code 1107): the hostname maps to no
            help center.
        '500':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnknownError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            UnknownError (error_code 5999): Unexpected internal error not
            otherwise documented for this endpoint.
components:
  schemas:
    MissingHelpdeskHostnameError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingHelpdeskHostnameError
          type: string
        error_code:
          enum:
            - 1106
          type: number
        message:
          example: The X-Helpdesk-Host header is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    HelpdeskNotFoundError:
      additionalProperties: false
      properties:
        error:
          enum:
            - HelpdeskNotFoundError
          type: string
        error_code:
          enum:
            - 1107
          type: number
        message:
          example: No help center answers on this address.
          type: string
        statusCode:
          enum:
            - 404
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnknownError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnknownError
          type: string
        error_code:
          enum:
            - 5999
          type: number
        message:
          example: For some unknown reason your request has not succeeded.
          type: string
        statusCode:
          enum:
            - 500
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object

````

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