Skip to main content
POST
Call library.search

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Body

application/json
query
string

Match items whose name contains this text. Omit to browse the shelf.

roll
enum<string>

Only this shelf. Omit to search all of them.

Available options:
images,
clips,
videos,
documents
pinned_only
boolean

Only items someone has pinned.

limit
integer
default:25

How many items to return. Pinned items come first.

Required range: 1 <= x <= 50
workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
total
number
required
truncated
boolean
required

True when more matched than were returned, or the search window was reached. Narrow by roll rather than trusting a short answer.

search_window
number
required

How many items the text match ran over — the newest of this workspace's finished work, pinned items first. Only meaningful with query.

items
object[]
required
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.