Skip to main content
POST
Search a source live

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

source
enum<string>
required
Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
dropbox,
github,
google_drive,
vault,
web_crawler,
trace,
microsoft_teams,
gmail_actions,
granola,
fathom,
fireflies,
linear,
hubspot,
salesforce,
coda,
lightfield,
gong,
pylon,
clickup

Body

application/json
query
string
required

Live search query.

index
boolean
default:false

If true, queue each hit for indexing so it's on-hand next time.

connection_id
string | null

Specific connection id when the user has multiple for this source.

Response

Successful Response

A fetch/search result: the live documents plus what happened to them.

documents
DocumentResponse · object[]
required
indexed
boolean
default:false
notes
string[]