Skip to main content

KeywordSearchRequest

Request schema for keyword/faceted search using Meilisearch.

queryQuery (string)required

Search query string (can be empty for filtering only)

Possible values: <= 500 characters

limitLimit (integer)

Maximum number of results to return

Possible values: >= 1 and <= 100

Default value: 20
offsetOffset (integer)

Number of results to skip (for pagination)

Possible values: >= 0

Default value: 0
dataset_ids object

Filter by dataset IDs

anyOf
  • Array [
  • integer
  • ]
  • status object

    Filter by entry status (e.g., 'processed')

    anyOf
    string
    mime_types object

    Filter by MIME types (e.g., ['application/pdf', 'image/png'])

    anyOf
  • Array [
  • string
  • ]
  • tags object

    Filter by tags

    anyOf
  • Array [
  • string
  • ]
  • sort object

    Sort fields (e.g., ['created_at:desc', 'file_size_bytes:asc'])

    anyOf
  • Array [
  • string
  • ]
  • KeywordSearchRequest
    {
    "query": "string",
    "limit": 20,
    "offset": 0,
    "dataset_ids": [
    0
    ],
    "status": "string",
    "mime_types": [
    "string"
    ],
    "tags": [
    "string"
    ],
    "sort": [
    "string"
    ]
    }