Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string

Search query text. Supports inline tags like #tag-name.

rewriteQuery
boolean

Rewrite query before embedding generation.

tag
string

Tag filter string. Multiple values can be comma- or space-separated.

tag_ids
string[]

Explicit tag IDs to filter on.

tagMatchStrategy
enum<string>
default:AND
Available options:
AND,
OR
dateFrom
string

Start date filter (free text or date string).

dateTo
string

End date filter (free text or date string).

timeRange
object
contentTypes
enum<string>[]

Restrict search to one or more exact content_entity.type values.

Exact persisted content_entity.type value.

Available options:
web,
pdf,
youtube,
twitter,
instagram,
tiktok,
facebook,
linkedin,
pinterest,
reddit,
chatgpt,
claude,
annotation,
image,
transcribedMedia,
audioRecording,
selector,
chatThread,
twitterProfile,
subreddit,
youtubeChannel
feedIds
string[]

Restrict search results to entries from one or more subscribed feed IDs returned by /list-feeds.

feedScope
enum<string>

Set to all to restrict search results to entries from all subscribed feeds. Omit both feedScope and feedIds to search the full library.

Available options:
all
feedReadStates
enum<string>[]

Optional read-state filter for feed entries. Omit to include unread and read entries while excluding archived entries.

Available options:
unread,
read,
archived
sortBy
enum<string>
default:date-desc
Available options:
date-asc,
date-desc
offset
integer
default:0
Required range: x >= 0
limit
integer
default:30

Maximum number of results returned per call.

Required range: 1 <= x <= 500
relevanceThreshold
number

Semantic relevance threshold for hybrid search.

enableRerank
boolean
default:false

If true and query is non-empty, reranks top candidates with an LLM.

rerankWindow
integer
default:100

Maximum candidate window used for reranking.

Required range: 1 <= x <= 100
includeTags
boolean
default:false

Includes related tags in the reference payload.

includeNotes
boolean
default:false

Includes related notes and each note's own references.

raw
boolean
default:false

Response mode switch. Omit or set false for the LLM-ready compact response. Set true for the full machine-readable search graph.

viewIds
string[]

Restrict search to one or more accessible saved view IDs. Use this when you need LLM-ready or full search responses scoped to views.

Response

Search response

Search response. Omit raw or set raw: false for the LLM-ready response; set raw: true for the full response.

results
object[]
required
meta
object
required
error
string

Present when search execution fails.

errorCode
enum<string>
Available options:
INSUFFICIENT_CREDITS
upgradeOptions
object