---
title: "Search documents"
method: GET
path: "/api/documents/search"
tags: ["Documents"]
---

# Search documents

`GET /api/documents/search`

## Request

- Base URL: `https://api.supovia.com`
- URL: `https://api.supovia.com/api/documents/search`
- Auth: one of:
  - HTTP basic
  - API key in header `Authorization`

Semantic (vector) search over your published help documents. Requires the `documents:read` scope.

## Query parameters

- `query` string, required
- `websiteId` string
- `locale` string

## Response `200`

Array of matching documents, best match first

---

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