Skip to main content
POST
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.

Body Parameters

query
string
required
The natural language search query.
sourceTypes
string[]
default:"[\"entity\", \"comment\", \"message\"]"
Content types to search. Any combination of entity, comment, message.
spaceId
string
Restrict search to a specific space.
includeChildSpaces
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.
conversationId
string
Restrict message search to a specific conversation.
limit
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 a spaceReputation 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):
Each result includes:
  • 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