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

# Rate article

> Records one vote on a published article, plus the optional free-text
feedback that is the most valuable part of the block — it is where a
customer tells the operator the article is wrong.

Answers 200 with `accepted: false` when the visitor is over the limit or
has already voted on this article in the last 24 hours, rather than an
error: from the visitor's side the vote was registered, and a duplicate is
not their mistake to see.

The article comes from `:slug` inside the resolved help center; the caller
never sends an `articleID`.



## OpenAPI

````yaml /api/helpdesk.yaml post /v1/public/articles/{slug}/rate
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/articles/{slug}/rate:
    post:
      tags:
        - Public
      summary: Rate article
      description: >-
        Records one vote on a published article, plus the optional free-text

        feedback that is the most valuable part of the block — it is where a

        customer tells the operator the article is wrong.


        Answers 200 with `accepted: false` when the visitor is over the limit or

        has already voted on this article in the last 24 hours, rather than an

        error: from the visitor's side the vote was registered, and a duplicate
        is

        not their mistake to see.


        The article comes from `:slug` inside the resolved help center; the
        caller

        never sends an `articleID`.
      operationId: RateArticleController
      parameters:
        - in: path
          name: slug
          required: true
          schema:
            maxLength: 160
            minLength: 1
            pattern: ^[a-z0-9][a-z0-9-]*$
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ratingFeedback:
                  maxLength: 2000
                  type: string
                ratingValue:
                  type: number
              required:
                - ratingValue
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  accepted:
                    type: boolean
                  reason:
                    enum:
                      - accepted
                      - rate-limited
                      - duplicated
                    type: string
                required:
                  - accepted
                  - reason
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/MissingHelpdeskHostnameError'
                        - $ref: '#/components/schemas/RequestValidationError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingHelpdeskHostnameError (error_code 1106): no hostname on the
            request. | RequestValidationError (error_code 1002): invalid slug,
            rating value, or feedback over 2000 characters.
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/HelpdeskNotFoundError'
                        - $ref: '#/components/schemas/ArticleNotFoundError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            HelpdeskNotFoundError (error_code 1107): the hostname maps to no
            help center. | ArticleNotFoundError (error_code 1109): no published
            article with this slug here.
        '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
    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
    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
    ArticleNotFoundError:
      additionalProperties: false
      properties:
        error:
          enum:
            - ArticleNotFoundError
          type: string
        error_code:
          enum:
            - 1109
          type: number
        message:
          example: Article not found.
          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.