create_saved_search

Create a saved search (a reusable, named query) for the account.

create_saved_search

Create a saved search (a reusable, named query) for the account.

Create a named saved search. Delete it in teardown (global account object).

Safety class: C · API type: portal · Min version: —

📘
Confinement
Class C: a saved search is a GLOBAL account object (not under the run-root folder). Delete it in teardown (cleanup registry). Non-prod only.

Signatures

def create_saved_search(sdk, name, query=None, featured=False, bookmarked=False):
    """Create a saved search; return the saved-search dict (carries its id)."""
    return sdk.add_saved_search(name, featured, bookmarked, query=query)

export async function createSavedSearch(sdk, name, query = null, featured = false, bookmarked = false) {
    // Positional: (name, featured, bookmarked, public, sequence, savedSearchType, query, offset, size, ...).
    return await sdk.addSavedSearch(name, featured, bookmarked, null, null, null, query);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`name`	`name`	str	yes	e.g. `docs-ai saved search`
`query`	`query`	str \| None	no	e.g. `docs-ai`
`featured`	`featured`	bool	no
`bookmarked`	`bookmarked`	bool	no

Returns

dict | None — the new saved search (carries its id); None on failure.

Errors

401 unauthenticated
InvalidAPITypeException on a non-portal session
400 invalid query