Search documents

Search documents using full-text search. - **q**: Search query (required, 1-500 characters) - **limit**: Maximum results (default 20, max 100) - **offset**: Pagination offset (default 0) - **folder_id**: Optional folder filter Results include: - Relevance score - Highlighted snippet with matching terms in <mark> tags

GET /api/search

Search documents

cURL

curl --request GET \
  --url https://api.example.com/api/search \
  --header 'Authorization: Bearer <token>'

200

{
  "results": [
    {
      "document": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "tags": [
          "<string>"
        ],
        "source_type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "score": 123,
      "snippet": "<string>"
    }
  ],
  "total": 123,
  "query": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q · string · required

Search query

Required string length: 1 - 500

limit · integer · default: 20

Max results to return

Required range: 1 <= x <= 100

offset · integer · default: 0

Pagination offset

Required range: x >= 0

folder_id · string<uuid> | null

Filter by folder ID

Response

200

application/json

Successful Response

Response schema for search.

results · SearchResult · object[] · required

Show child attributes

total · integer · required

query · string · required