Search documents

Search one or more collections using natural language or keyword queries. Results are ranked by relevance using hybrid retrieval (dense + sparse + reranking). Pass `collections` (up to 5) to search several collections in one call and receive a single merged, relevance-ranked list with per-result origin labels.

Authorization

BearerAuth

AuthorizationBearer <token>

API key authentication. Pass your key in the Authorization header as Bearer sk_live_.... An X-API-Key: sk_live_... header is also accepted as an alternative. Keys are created in the Redpine Connect dashboard under Settings > API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Provide exactly one of collection (single) or collections (multi-collection search).

collection?|

Name of the collection to search. Mutually exclusive with collections.

Defaultnull

collections?array<string>|

Collections to search together (max 5, unique). Each collection is searched with its own access entitlements and the results are merged into one relevance-ranked list; each result carries its origin collection. Mutually exclusive with collection.

Items1 <= items <= 5

Defaultnull

filters?|

Optional metadata filter. Two accepted forms.

Flat (top-level keys are ANDed): {"journal": "Nature", "publication_date": {"gte": "2020-01-01"}}.

Structured DSL (for OR / nesting): {"and": [{"field": "journal", "eq": "Nature"}]}. Operators: eq, ne, in, not_in, gt, gte, lt, lte, between. Combinators: and, or, not.

Exclusion uses ne / not_in / not — there is no separate syntax: {"and": [{"field": "issn", "not_in": ["1234-5678"]}]}.

Indexed on every collection (any other field is matched by scanning and returns a filterWarnings entry): article_type, doc_id, doi, issn, journal, keywords, publication_date, publisher, section.

Indexed on the editorial collections only (People Inc): medical_board_approved, topic, url.

issn accepts hyphenated or bare, upper- or lower-case X ("1664-302X", "1664302x"). doi is matched case-insensitively and an optional https://doi.org/ or doi: prefix is accepted.

journal_metric.2yr_mean_citedness, journal_metric.h_index and journal_metric.i10_index accept range operators only and are resolved server-side into the matching ISSNs; see journalMetricExpansions in the response.

Defaultnull

imageMaxHeight?integer

Maximum image height in pixels

Range100 <= value <= 1080

Default600

imageMaxWidth?integer

Maximum image width in pixels

Range100 <= value <= 1920

Default800

imageQuality?integer

JPEG quality for fetched images

Range1 <= value <= 100

Default75

includeFigures?boolean

Fetch and include figure images as base64 in metadata (adds latency). includeImages is accepted as a deprecated alias.

Defaultfalse

includeMetadata?boolean

Whether to include metadata in results

Defaulttrue

limit?integer

Maximum results to return (default 10, max 30)

Range1 <= value <= 30

Default10

query*string

Natural language or keyword search query.

Length1 <= length <= 1000

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/search/query" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'

{  "filterWarnings": null,  "journalMetricExpansions": null,  "latencyMs": 0,  "queryId": "string",  "results": [    {      "collection": null,      "id": "string",      "metadata": null,      "text": "string"    }  ]}

Authorization

Request Body

Response Body

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`