Skip to main content
POST
/
live
/
{source}
/
search
Search a source live
curl --request POST \
  --url https://api.hyperspell.com/live/{source}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "index": false,
  "connection_id": "<string>"
}
'
{
  "documents": [
    {
      "resource_id": "<string>",
      "title": "<string>",
      "metadata": {
        "created_at": "2023-11-07T05:31:56Z",
        "indexed_at": "2023-11-07T05:31:56Z",
        "last_modified": "2023-11-07T05:31:56Z",
        "status": "pending",
        "events": [
          {
            "message": "<string>",
            "time": "2023-11-07T05:31:56Z"
          }
        ],
        "url": "<string>"
      },
      "score": 123,
      "folder_id": "<string>",
      "parent_folder_id": "<string>",
      "folder_ancestors": [
        "<string>"
      ]
    }
  ],
  "indexed": false,
  "notes": [
    "<string>"
  ]
}

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

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
Resource · object[]
required
​
indexed
boolean
default:false
​
notes
string[]