Search

Search items and lists

Search the user's Roma workspace — their items (tasks, notes, the rows of every list they keep) and their lists, and what others shared with them (an item shared on its own, a list they joined and every item on it, each marked isSharedWithMe) — by meaning or keyword (hybrid semantic + keyword retrieval). Use this when the user asks about their own information, plans or anything they may have saved, and before adding something that may already exist. Their wording often won't match their notes' wording; the semantic arm bridges that gap (and across languages). Returns the best-matching passage per item, each with its list; get_item returns an item in full. An empty result means nothing relevant is saved. Not for general web knowledge.

get/api/v1/search

Request

  • Base URL
    https://api.roma.app
  • URL
    https://api.roma.app/api/v1/search
  • Auth
    HTTP bearer

Query parameters

qstring required

Natural-language query — what the user is trying to find, in their words.

limitinteger

Max results (default 10).

afterstring

Only items CREATED on/after this ISO 8601 timestamp. Use when scoping by when it was saved ("last week", "in March").

beforestring

Only items CREATED before this ISO 8601 timestamp (exclusive). Pair with after to bound a window.

Response

The tool's result.

countnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.