---
title: "Search articles"
method: GET
path: "/kb-search"
tags: ["Search"]
---

# Search articles

`GET /kb-search`

## Request

- Base URL: `https://api.weav.com/v1`
- URL: `https://api.weav.com/v1/kb-search`
- Auth: HTTP bearer

## Query parameters

- `q` string, required
- `locale` string
- `status` 'draft' | 'published'
- `category_id` string, uuid
- `uncategorized` boolean
- `per_page` integer
- `page` integer

## Response `200`

Success

- object
  - `data` KbArticle[]
    - `id` string, uuid
    - `category_id` string, uuid, nullable
    - `position` integer, nullable
    - `status` 'draft' | 'published'
    - `published_at` string, date-time, nullable
    - `source` 'manual' | 'auto_generated' | 'github' | 'mcp'
    - `translations` KbArticleTranslation[]
      - `locale` string
      - `title` string
      - `slug` string
      - `content` string: Markdown body
      - `excerpt` string, nullable: Also used as the meta description
      - `seo_title` string, nullable: Search and social title; the page heading remains title
      - `noindex` boolean: Hide this translation from search engines
      - `canonical_url` string, uri, nullable
      - `og_image_url` string, uri, nullable
      - `created_at` string, date-time, nullable
      - `updated_at` string, date-time, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `meta` object
    - `search_method` 'keyword'

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/weav/apis/weav-api.md) · [All operations](https://skmtc.dev/weav/apis/weav-api/llms.txt) · [OpenAPI document](https://skmtc.dev/weav/apis/weav-api/revisions/15970f126c0e?raw)
