Skip to main content
POST
/
live
/
{source}
/
passthrough
Raw live read against a source
curl --request POST \
  --url https://api.hyperspell.com/live/{source}/passthrough \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "method": "GET",
  "query": {},
  "body": {},
  "connection_id": "<string>"
}
'
import requests

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

payload = {
"path": "<string>",
"method": "GET",
"query": {},
"body": {},
"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({
path: '<string>',
method: 'GET',
query: {},
body: JSON.stringify({}),
connection_id: '<string>'
})
};

fetch('https://api.hyperspell.com/live/{source}/passthrough', 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}/passthrough",
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([
'path' => '<string>',
'method' => 'GET',
'query' => [

],
'body' => [

],
'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}/passthrough"

payload := strings.NewReader("{\n \"path\": \"<string>\",\n \"method\": \"GET\",\n \"query\": {},\n \"body\": {},\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}/passthrough")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"path\": \"<string>\",\n \"method\": \"GET\",\n \"query\": {},\n \"body\": {},\n \"connection_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"path\": \"<string>\",\n \"method\": \"GET\",\n \"query\": {},\n \"body\": {},\n \"connection_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "method": "<string>",
  "path": "<string>",
  "payload": "<unknown>",
  "truncated": 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
path
string
required

Provider-native path, e.g. 'gmail/v1/users/me/messages'.

method
enum<string>
default:GET

Provider HTTP method. Writes (PATCH/PUT/DELETE) are rejected.

Available options:
GET,
POST,
PATCH,
PUT,
DELETE
query
Query · object | null

Query-string params for GET reads.

body
Body · object | null

JSON body for read-via-POST (e.g. GraphQL).

connection_id
string | null

Specific connection id when the user has multiple.

Response

Successful Response

A raw passthrough read: the provider's payload verbatim, plus what happened.

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
method
string
required
path
string
required
payload
any
required
truncated
boolean
default:false
notes
string[]