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>"
}
'
import requests

url = "https://api.hyperspell.com/live/{source}/search"

payload = {
"query": "<string>",
"index": False,
"connection_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', index: false, connection_id: '<string>'})
};

fetch('https://api.hyperspell.com/live/{source}/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/live/{source}/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'index' => false,
'connection_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.hyperspell.com/live/{source}/search"

payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"index\": false,\n \"connection_id\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.hyperspell.com/live/{source}/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"index\": false,\n \"connection_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hyperspell.com/live/{source}/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"index\": false,\n \"connection_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "documents": [
    {
      "resource_id": "<string>",
      "type": "<string>",
      "document": {
        "type": "document",
        "id": "<string>",
        "metadata": {
          "sources": [
            {
              "chunk_id": "<string>",
              "resource_id": "<string>",
              "source": "<string>",
              "score": 123
            }
          ],
          "edited_by": "<string>"
        },
        "text": "<string>",
        "children": [
          {
            "mimetype": "<string>",
            "data": "<string>",
            "type": "blob",
            "id": "<string>",
            "metadata": {
              "sources": [
                {
                  "chunk_id": "<string>",
                  "resource_id": "<unknown>",
                  "source": "<unknown>",
                  "score": "<unknown>"
                }
              ],
              "edited_by": "<string>"
            }
          }
        ],
        "title": "<string>"
      },
      "title": "<string>",
      "collection": "<string>",
      "metadata": {},
      "ingested_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "document_date": "2023-11-07T05:31:56Z"
    }
  ],
  "indexed": false,
  "notes": [
    "<string>"
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<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,
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[]