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

• integer[]
• null

Array [

integer

]

status object

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

anyOf

• string
• null

string

mime_types object

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

anyOf

• string[]
• null

Array [

string

]

tags object

Filter by tags

anyOf

• string[]
• null

Array [

string

]

metadata_filters object

Filter by metadata fields registered in the dataset schema. Keys are field names (e.g., 'doi', 'authors'), values are exact match values. Example: {"doi": "10.1101/037192"} or {"authors": "John Smith"}

anyOf

• object
• null

object

sort object

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

anyOf

• string[]
• null

Array [

string

]

context_modeContext Mode (string)

Context extraction mode: 'smart' tries sentence→paragraph→section→crop

Possible values: [sentence, paragraph, section, smart]

Default value: smart

max_snippetsMax Snippets (integer)

Maximum number of snippets to return per result

Possible values: >= 1 and <= 10

Default value: 3

max_crop_lengthMax Crop Length (integer)

Maximum length in characters for cropped snippets (if section/paragraph too long)

Possible values: >= 100 and <= 1000

Default value: 400

KeywordSearchRequest

{
  "query": "string",
  "limit": 20,
  "offset": 0,
  "dataset_ids": [
    0
  ],
  "status": "string",
  "mime_types": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "metadata_filters": {
    "doi": "10.1101/037192"
  },
  "sort": [
    "string"
  ],
  "context_mode": "smart",
  "max_snippets": 3,
  "max_crop_length": 400
}