Skip to main content
POST
Search Context
Search returns up to topK records (default 10, maximum 50). Each record includes up to segmentsPerRecord matching passages (default 1, maximum 5). Results are ordered by relevancy, a rank-based score for ordering results within a single response. Don’t compare relevancy values across different requests. When reranking is applied, rerankScore holds the reranker’s score for that passage. Otherwise it is null. To read more of the text around a passage, pass its pointer to Read Segment Context.

Authorizations

Authorization
string
header
required

Your Paragon User Token (JWT), which you can generate using your project's signing keys.

Path Parameters

projectId
string<uuid>
required

Your Paragon Project ID. Must match the Project ID in your Paragon User Token.

Body

application/json
query
string
required

The text to search for.

Required string length: 1 - 1024
sources
enum<string>[]

Limit the search to these sources. If omitted, all sources are searched.

Maximum array length: 6
Available options:
onedrive,
sharepoint,
dropbox,
box,
confluence,
googledrive
syncIds
string<uuid>[]

Limit the search to these syncs. If omitted, all syncs are searched.

Maximum array length: 50
topK
integer
default:10

The maximum number of records to return.

Required range: 1 <= x <= 50
segmentsPerRecord
integer
default:1

The maximum number of matching passages to return for each record.

Required range: 1 <= x <= 5
rerank
boolean

Set to false to skip reranking the results.

identity

The account whose access applies. Pass a string to use one account on every source, or an array to use a different account for each source.

Maximum string length: 1024
email
string
deprecated

Deprecated. Use identity instead.

Maximum string length: 1024

Response

The matching records and their best passages.

results
object[]
required
usage
object
required

Details about how the search was run.