Skip to main content
GET
Search documents

Authorizations

scribe_session
string
cookie
required

Browser session cookie set by the WorkOS sign-in flow.

Query Parameters

q
string
required

Full-text search query.

Required string length: 1 - 200
Example:

"launch"

scope
enum<string>

Restrict results to one sidebar section. Omit to search everywhere.

Available options:
workspace,
private,
shared
Example:

"workspace"

Response

The search results.

Full-text search results, filtered by what the caller can read.

results
object[]
required

Matching documents, best match first.

Example: