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

# Check helpdesk slug

> Previews whether a public address (`helpdeskSlug`) is available, applying
the exact rules the save enforces: `slugify()` normalization, the reserved
list, and the global uniqueness index. Answers per keystroke for the
onboarding's address field, so the operator never discovers a conflict
only after submitting.

Not scoped by tenant — slug uniqueness is global across every help
center — and read-only: checking never reserves the address.



## OpenAPI

````yaml /api/helpdesk.yaml get /v1/helpdesks/check-slug
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/helpdesks/check-slug:
    get:
      tags:
        - Helpdesk
      summary: Check helpdesk slug
      description: >-
        Previews whether a public address (`helpdeskSlug`) is available,
        applying

        the exact rules the save enforces: `slugify()` normalization, the
        reserved

        list, and the global uniqueness index. Answers per keystroke for the

        onboarding's address field, so the operator never discovers a conflict

        only after submitting.


        Not scoped by tenant — slug uniqueness is global across every help

        center — and read-only: checking never reserves the address.
      operationId: CheckHelpdeskSlugController
      parameters:
        - in: query
          name: slug
          required: true
          schema:
            maxLength: 120
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  available:
                    type: boolean
                  normalized:
                    type: string
                  reason:
                    enum:
                      - reserved
                      - taken
                      - invalid
                    type: string
                required:
                  - available
                  - normalized
                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): `slug` absent or over 120
            characters.
        '429':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/TooManyRequestsError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            TooManyRequestsError (error_code 1113): more than 30 checks in a
            minute from this caller.
        '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
    TooManyRequestsError:
      additionalProperties: false
      properties:
        error:
          enum:
            - TooManyRequestsError
          type: string
        error_code:
          enum:
            - 1113
          type: number
        message:
          example: Too many requests. Please slow down and try again shortly.
          type: string
        statusCode:
          enum:
            - 429
          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.