Preview search results without charging

Run the same pipeline as POST /api/v1/search/query -- same entitlement checks, same retraction filtering, same relevance ranking -- but never charge for it. Every result comes back locked, with a teaser snippet in `text` and the cost to unlock it. Works even at a zero balance. Consumes no credits, no trial query and no quota. Call POST /api/v1/search/unlock with the returned `queryId` to pay for and receive some or all of the results in full.

POST/api/v1/search/preview

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.

Keys come in two kinds. A live key (sk_live_...) searches real content and spends credits. A sandbox key (sk_test_...) returns canned results at no cost and never reaches licensed content, so you can build and test an integration before spending anything. Sandbox responses have the same shape as live ones and every result is marked synthetic, so going live is a matter of swapping the key. Check the X-Billing-Mode response header to confirm which you are using.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The result-selection half of SearchRequest. A preview quotes results rather than delivering them, so it takes no content-delivery options: figures are never fetched (they are not priced into the quote) and metadata is always returned. Provide exactly one of collection (single) or collections (multi).

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-5679"]}]}.

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

Indexed on the editorial collections only: last_updated_date, medical_board_approved, topic, url.

open_access is also answered for a collection that holds only open-access content and carries no such field: true matches everything there, false (or the field under or / not) excludes that collection with a filterWarnings entry. license is returned in result metadata but is not filterable.

issn accepts hyphenated or bare, upper- or lower-case X ("1234-561X", "1234561x"). 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

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/preview" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'

{  "costCharged": null,  "costToUnlockRemaining": "string",  "filterWarnings": null,  "journalMetricExpansions": null,  "queryId": "string",  "results": [    {      "collection": null,      "cost": null,      "id": "string",      "locked": true,      "metadata": null,      "text": "string",      "tokens": null    }  ]}

Preview search results without charging

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`