---
title: "Search help articles"
url: "https://kongnet.kongai.uk/apis/kongnet-telco-api-1/versions/3d9e2c10-cf93-4e6e-8bf8-2129457a6aa5/operations/search_knowledge_base"
---

> Full API specification: https://kongnet.kongai.uk/apis/kongnet-telco-api-1/versions/3d9e2c10-cf93-4e6e-8bf8-2129457a6aa5.md

# Search help articles

`GET` `/kb/search`

Operation ID: `search_knowledge_base`

Full text search over KongNet troubleshooting articles. Use two to four plain words such as 'slow wifi evening' or 'red light'. Returns article ids, titles, a snippet and a score. Follow up with get_article for the steps.

## Query parameters

- `q` (string, required) - Search words
- `limit` (integer, optional) - Maximum results

## Responses

- `200` - Successful Response
- `422` - Validation Error

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: KongNet Telco API
  version: 1.0.0
paths:
  /kb/search:
    get:
      tags:
        - kb
      summary: Search help articles
      description: Full text search over KongNet troubleshooting articles. Use two to
        four plain words such as 'slow wifi evening' or 'red light'. Returns
        article ids, titles, a snippet and a score. Follow up with get_article
        for the steps.
      operationId: search_knowledge_base
      parameters:
        - name: q
          in: query
          required: true
          schema:
            type: string
            minLength: 2
            maxLength: 120
            description: Search words
            title: Q
          description: Search words
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 10
            minimum: 1
            description: Maximum results
            default: 3
            title: Limit
          description: Maximum results
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
```