Skip to main content
GET
/
live
/
{source}
/
manifest
Describe a source's full live query surface
curl --request GET \
  --url https://api.hyperspell.com/live/{source}/manifest \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hyperspell.com/live/{source}/manifest', 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}/manifest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.hyperspell.com/live/{source}/manifest")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "capabilities": [],
  "raw_read_ops": [
    {
      "name": "<string>",
      "path": "<string>",
      "description": "<string>",
      "method": "GET",
      "params": {},
      "graphql": false
    }
  ],
  "raw_discovery": "<string>",
  "guidance": [
    "<string>"
  ],
  "resolvable": [
    "<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

Query Parameters

connection_id
string | null

Specific connection id.

Response

Successful Response

Everything the caller can ask of a source — read before composing a query.

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
auth_provider
enum<string> | null
required
Available options:
nango,
unified,
whitelabel
capabilities
enum<string>[]
required

Live-access capabilities an integration may implement.

Used by LiveSourceAccess (and its LLM/HTTP surfaces) to advertise what a connected source can do on-demand. LIST_RESOURCES / FETCH_RESOURCE / SEARCH_LIVE are detected via method-override introspection (see Integration.supports), so they reflect reality with no per-integration declaration to keep in sync.

PASSTHROUGH is the exception: it is declared (via live_raw_read_ops), not introspected — see specs/components/live-query-framework.md. A source supports it when it exposes a non-empty raw read surface (the agent composes raw provider reads against it).

Available options:
list_resources,
fetch_resource,
search_live,
passthrough,
resolve,
query_structured
raw_read_ops
RawReadOp · object[]
required
raw_discovery
string
required
guidance
string[]
resolvable
string[]