---
title: "Search knowledge base visual components"
method: GET
path: "/api/v0/knowledge-bases/{kb_id}/visual-components/search"
tags: ["Knowledge Bases"]
---

# Search knowledge base visual components

`GET /api/v0/knowledge-bases/{kb_id}/visual-components/search`

Search visual component labels, descriptions, and content within a knowledge base using a literal, case-insensitive keyword.

## Path parameters

- `kb_id` string, uuid, required

## Query parameters

- `q` string, required
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- KnowledgeBaseVisualComponentSearchResponse — Paginated visual-component keyword matches.
  - `results` KnowledgeBaseVisualComponentSearchItem[], required — The matching visual components.
    - `component_id` string, uuid, required — The public ID of the visual component.
    - `document_id` string, uuid, required — The public ID of the containing document.
    - `document_name` string, required — The name of the containing document.
    - `type` string, required — The visual component type.
    - `label` string, required — The visual component label.
    - `page_number` integer, nullable, required — The zero-based component page.
    - `sequence_number` integer, nullable, required — The component order within its page.
    - `matched_fields` string[], required — The searchable fields containing the literal query.
    - `snippet` string, required — Text surrounding the first keyword match.
  - `pagination` PaginationMetadata, required
    - `total` integer, required — The total number of items matching the query.
    - `limit` integer, required — The maximum number of items per page.
    - `offset` integer, required — The number of items skipped.
    - `has_more` boolean, required — Whether there are more items available.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/outerport/apis/outerport-api.md) · [All operations](https://skmtc.dev/outerport/apis/outerport-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/outerport/outerport-api/revisions/f565b46daaea/schema)