Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Body

application/json
query
string
required

The natural-language search query.

Example:

"what is our refund policy?"

limit
integer
default:8

Maximum number of results to return.

Required range: 1 <= x <= 50
Example:

8

source_type
enum<string>[] | null

Restrict results to specific source types. Omit to search every source you can access. Valid values: notion, google_drive, slack, github, confluence, direct_file_uploads, gumloop_artifacts.

Minimum array length: 1
Available options:
notion,
google_drive,
slack,
github,
confluence,
direct_file_uploads,
gumloop_artifacts
Example:

Response

Ranked search results.

results
object[]
required

Ranked matches, most relevant first.