Assisted search (verified results only)

Agentic search: the query is interpreted, one or more internal searches are planned and run, every candidate is verified as actually addressing the query, and only verified results are returned. **Billing differs from `/search/query`:** only delivered, verified results are charged. A clarification request or an honest no-results answer costs nothing. Internal search fan-out and LLM tokens are absorbed by Redpine. Accepts the same `filters` as `/search/query`, applied to every internal search.

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.

allowClarification?boolean

If true, the endpoint may return a clarifying question instead of results when the query is too underspecified. Set false if your client cannot do a follow-up turn.

Defaulttrue

collection?|

Collection to search. Provide either this or collections, not both.

Defaultnull

collections?array<string>|

Collections to search together (max 5). Results are merged into one relevance-ranked list and each result is labeled with its origin collection. Provide either this or 'collection', not both.

Items1 <= items <= 5

Defaultnull

filters?|

Same filter forms as /api/v1/search/query; applied to every internal search.

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 attach figure images (base64, in metadata.figures[].image_data) for the delivered results only. Adds latency; requires includeMetadata. includeImages is accepted as a deprecated alias.

Defaultfalse

includeMetadata?boolean

Whether to include metadata in results

Defaulttrue

limit?integer

Maximum verified results to return.

Range1 <= value <= 30

Default10

query*string

Search query text

Length1 <= length <= 1000

Response Body

`application/json`

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

{  "billing": {    "chargedResults": 0,    "tokensCharged": 0  },  "clarification": {    "question": "string",    "reason": ""  },  "filterWarnings": null,  "iterationsRun": 0,  "journalMetricExpansions": null,  "latencyMs": 0,  "queryId": "string",  "queryUnderstanding": {    "aspects": [      "string"    ],    "entities": [      "string"    ],    "filters": {},    "intent": ""  },  "results": [    {      "collection": null,      "doiUrl": null,      "id": "string",      "metadata": null,      "relevance": {        "judgeScore": 0,        "matchedTerms": [          "string"        ],        "rationale": ""      },      "section": null,      "text": "string"    }  ],  "status": "results"}

Assisted search (verified results only)

Authorization

Request Body

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`