Skip to main content

Search API

Full-text search across your workspace.

Search Query

GET /v1/search

Parameters

ParameterTypeRequiredDescription
querystringYesSearch query
workspaceIdstringYesWorkspace ID
spaceIdstringNoFilter by space
typesstring[]NoContent types: page, task
limitnumberNoResults per page

Example Request

curl "http://localhost:3000/api/search?workspaceId=ws_123&query=authentication" \
-H "Authorization: Bearer $API_KEY"

Example Response

{
"data": [
{
"type": "page",
"id": "page_abc123",
"title": "Authentication Guide",
"snippet": "...implement authentication using OAuth 2.0...",
"score": 0.95,
"spaceId": "space_456",
"updatedAt": "2025-01-15T10:00:00Z"
}
]
}

Search Suggestions

GET /v1/search/suggest

Returns autocomplete suggestions.

Parameters

ParameterTypeRequiredDescription
querystringYesPartial query
workspaceIdstringYesWorkspace ID
limitnumberNoMax suggestions

Example Response

{
"data": [
{ "text": "authentication", "type": "keyword" },
{ "text": "Authentication Guide", "type": "page", "id": "page_abc123" }
]
}