Save Search

Save a reusable Search query for your account.

POST/search/v2/save-search

Related NOSIBLE resources

research & data

Inspect the Search data dictionary or read NOSIBLE research for implementation context and methods.

Authorizations

apiKey

Api-Keystringrequiredheader

Your NOSIBLE API key from the API Dashboard.

Example: nos_sk_...

Body

application/json

search_idstringbody

Existing saved-search identifier when updating a configuration. Omit it to create a new saved search.

Example: search_01J...

extra_argsobjectbody

Additional non-secret arguments passed to the saved search runner.

Example: {}

questionstringbody

The question the search should answer. 1–500 characters; use this as the primary information need.

Example: What is driving AI chip demand?

n_resultsintegerbody

Number of results stored in the recurring configuration, from 10 to 100.

Example: 100

n_probesintegerbody

Number of shards evaluated by the saved search, from 5 to 1000.

Example: 500

n_contextifyintegerbody

Context words stored per result, from 64 to 1024.

Example: 256

instructionstringbody

Instruction passed to the embedding mode. Keep it short and purposeful; it is not a replacement for the question.

Example: Retrieve evidence about semiconductor demand.

expansionsstring[]body

Up to 10 semantically or lexically related formulations that broaden recall without changing the underlying intent.

Example: ["AI accelerator demand", "data-center GPU spending"]

sql_filterstringbody

Optional SQL expression over indexed document metadata. Common columns include netloc, published, modified, visited, words, and chars.

Example: SELECT loc FROM engine WHERE words >= 30

algorithmenumbody

Scoring algorithm. hybrid-3 is the recommended default for general-purpose retrieval.

Example: hybrid-3

min_similaritynumberbody

Reject results below this similarity threshold. Must be between 0 and 1; it is a score threshold, not a probability.

Example: 0.35

must_includestring[]body

Terms that must appear in each result. Use sparingly: every additional hard constraint can reduce recall.

Example: ["NVIDIA"]

must_excludestring[]body

Terms that must not appear in a result.

Example: ["job listing"]

brand_safetyenumbody

Content-safety class: Safe, Sensitive, or Unsafe.

Example: Safe

languageenumbody

Language classification used to refine retrieval, such as EN, FR, or DE.

Example: EN

continentenumbody

Continent filter for the indexed document.

Example: Europe

regionenumbody

Geographic region filter for the indexed document.

Example: Western Europe

countryenumbody

Country filter using the API's canonical country values.

Example: Germany

sectorenumbody

GICS sector filter.

Example: Information Technology

industry_groupenumbody

GICS industry-group filter.

Example: Semiconductors & Semiconductor Equipment

industryenumbody

GICS industry filter.

Example: Semiconductors

sub_industryenumbody

GICS sub-industry filter.

Example: Semiconductor Equipment

iab_tier_1enumbody

IAB tier-1 content category.

Example: Business

iab_tier_2enumbody

IAB tier-2 content category.

Example: Business Services

iab_tier_3enumbody

IAB tier-3 content category.

Example: Investing

iab_tier_4enumbody

IAB tier-4 content category.

Example: Stocks

companiesstring[]body

Up to three company names used to refine retrieval.

Example: ["NVIDIA", "TSMC"]

collectionenumbody

Collection to search. everything searches the full available collection; this-week restricts to recently added data.

Example: everything

deduplicatebooleanbody

Deduplicate results that represent the same headline or story.

Example: true

How to use this endpoint

guidance

Use Save Search for managed, recurring retrieval configurations. This endpoint is account-scoped and currently requires the crawl-feed capability; do not place secrets in extra_args.

Response body

application/json

These are the fields you can build against. Nested names use dot notation; optional sections are called out in their descriptions.

messagestring

Confirmation that the search configuration was saved or updated.

Example: Search saved successfully.

response.search_idstring

Identifier to use when updating or deleting the saved search.

Example: search_01J...

Responses and errors

HTTP

200Request succeeded. The response body is shown in the panel on the right.

400invalid_search — The saved configuration cannot be compiled.

401unauthorized — The API key or crawl-feed capability is not valid.

500save_failed — The saved search could not be persisted.