Projects

Search project content

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).

get/api/v2/projects/{slug}/search/

Request

  • Base URL: https://app.biel.ai
  • URL: https://app.biel.ai/api/v2/projects/{slug}/search/
  • Auth: one of:
    • API key in header Authorization
    • none

Path parameters

slugstring required

Project slug identifier.

Query parameters

qstring required

Search query

urlstring

URL from where the search was initiated.

search_type'keyword' | 'hybrid'

Retrieval algorithm, independent of the selected source types.

source_typesstring

Comma-separated source categories, such as page,file or page,file,openapi. Use all for every category. Omit for page snippets; specifying this parameter returns full indexed chunks, document IDs and location references, including for page alone.

filter_titlestring

Optional filter to restrict search results to documents matching this filter title.

Response

Search results

Changes

No recorded changes to this operation across all 1 revision of this API.