Search project content
GET/api/v2/projects/:slug/search/
Keyword search across indexed project content by default. Set
search_type=hybrid to combine keyword matches and semantic similarity.
Source selection is independent: omit source_types for web-page snippets,
or supply a comma-separated list of page, file, repository, openapi
(or all) to retrieve indexed chunks from those source categories without
generating an answer. Document results include source type, full chunk text,
and available page or worksheet references. Non-URL sources have url: null.
Explicit source selections also include an opaque document_id. Pass it to
GET /api/v2/projects/{slug}/documents/{document_id}/ to read the complete
indexed text, following continuation cursors for larger documents.
References belong to this project and its current index; search again
after an index refresh. This endpoint does not accept a limit parameter;
the MCP search tool limits the results it presents to its caller.
Hybrid retrieval requires an index with embeddings configured. Backend
failures return an error without an automatic keyword fallback.
Existing project access, domain, trial, and interaction-limit checks apply.
URL-based filter_title filters exclude results without a matching URL.
Each successful search counts as one interaction toward your team's allowance. With extra usage enabled, interactions beyond that allowance cost $0.05 each. See extra usage.
Required permission: search (private projects only).
Request
Responses
- 200
- 400
- 403
- 404
Search results
Bad request. Invalid or missing data.
Forbidden. Missing permissions.
Resource not found.