Search Content
Search Endpoints
Search Content
Semantic search over entities, comments, and messages
Search Content
Performs vector-similarity search over project content (entities, comments, and chat messages) using AI embeddings. Returns the most semantically relevant results for the given query.
Requires a paid plan with semantic search enabled.
Requires an authenticated user. Send the user’s access token as
Each result includes:
Authorization: Bearer <token> — missing token → 401, invalid/expired token → 403 (refresh and retry).
Body Parameters
string
required
The natural language search query.
string[]
default:"[\"entity\", \"comment\", \"message\"]"
Content types to search. Any combination of
entity, comment, message.string
Restrict search to a specific space.
boolean
default:"false"
Only applies with a
spaceId. When true, the search also includes every space nested under it — children, grandchildren, the whole subtree at any depth — not just the named space. Ignored without a spaceId.string
Restrict message search to a specific conversation.
number
default:"20"
Maximum number of results to return. Maximum
50.Query Parameters
Space-scoped reputation
This endpoint has a space in context, so it accepts the opt-in reputation params. They add aspaceReputation field to each result record’s populated user, alongside the always-present reputation total. Requires the reputation bundle. See the Reputation data model for the full contract.
Response
Returns an array of result objects ordered by similarity (highest first):sourceType— one of"entity","comment", or"message", indicating which type of record was matched.similarity— cosine similarity score between the query and the matched content.record— the fully populated entity, comment, or chat message object.
Error Responses
Authentication Required — 401 / 403
Authentication Required — 401 / 403
The endpoint requires an authenticated user. A missing token returns a bare
401; an invalid or expired token returns a bare 403 — refresh the access token and retry.Plan Required — 403
Plan Required — 403

