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>"
}
'
{
  "method": "<string>",
  "path": "<string>",
  "payload": "<unknown>",
  "truncated": 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
​
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

Query-string params for GET reads.

​
body
Body · object

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