Search Notes by Keyword
| ⚠️ This endpoint is currently in BETA |
|---|
Search notes by keyword. The scope of the search is controlled by the request body:
- Provide
noteIdsto limit the search to specific notes. - Provide
companyIdto limit the search to notes associated with a specific company. - Omit both to search across your entire account.
noteIds and companyId are mutually exclusive.
Returns up to limit notes ordered by relevance. Prompts with no strong matches may
still return low-relevance results.
Each result contains a matched note and a single representative excerpt (a matching passage from that note). Even if a note contains multiple matching passages, it appears exactly once in the response with one excerpt.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- Note Keyword Search Criteria (org-wide or by note IDs)
- Note Keyword Search Criteria (by company)
Search all notes in the org, or limit to specific note IDs.
The search query. Returns up to limit notes ordered by relevance. Prompts with
no strong matches may still return low-relevance results.
3 - 500"Series B terms"
Limit search to these specific notes. Omit for org-wide search.
1001 <= x <= 2147483647[1, 2]Maximum number of notes to return.
1 <= x <= 100Response
Created
Results of a keyword search over notes.
Matching note results, one per note, ordered by relevance.
100