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

# Install pre

> Creates (or resolves, on a retry) the tenant's help center and answers with
the `helpdeskID` the core API persists as `pluginConnection.settings.helpdeskID`.



## OpenAPI

````yaml /api/helpdesk.yaml post /install/pre
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:
  /install/pre:
    post:
      tags:
        - Install
      summary: Install pre
      description: >-
        Creates (or resolves, on a retry) the tenant's help center and answers
        with

        the `helpdeskID` the core API persists as
        `pluginConnection.settings.helpdeskID`.
      operationId: InstallPreController
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              properties:
                connection:
                  properties:
                    pluginConnectionID:
                      minLength: 1
                      type: string
                  required:
                    - pluginConnectionID
                  type: object
                plugin:
                  properties:
                    pluginID:
                      minLength: 1
                      type: string
                    pluginURN:
                      minLength: 1
                      nullable: true
                      type: string
                  required:
                    - pluginID
                  type: object
                tenant:
                  properties:
                    tenantID:
                      minLength: 1
                      type: string
                    tenantName:
                      maxLength: 200
                      nullable: true
                      type: string
                  required:
                    - tenantID
                  type: object
              required:
                - tenant
                - plugin
                - connection
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  helpdeskID:
                    type: string
                required:
                  - helpdeskID
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/RequestValidationError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            RequestValidationError (error_code 1002): body fails schema
            validation.
        '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:
    RequestValidationError:
      additionalProperties: false
      properties:
        error:
          enum:
            - RequestValidationError
          type: string
        error_code:
          enum:
            - 1002
          type: number
        fields:
          items:
            additionalProperties: false
            properties:
              allowed:
                type: string
              field:
                type: string
              received:
                type: string
            required:
              - field
              - received
              - allowed
            type: object
          type: array
        message:
          example: Invalid request data.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
        - fields
      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.