Skip to main content
GET
JavaScript

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
resource_id
string
required

Response

Successful Response

A document-shaped API response carrying the hyperdoc tree (ENG-2479/D12).

resource_id
string
required
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
type
string
required

Hyperdoc document type discriminator (document, message, file, event, ...).

document
Document · object
required

The full hyperdoc tree. Switch on type for the document frame and recurse children for the body — see the <Hyperdoc /> renderer.

title
string | null

Human-readable document title.

status
enum<string> | null

Indexing status of the document.

Available options:
pending,
processing,
completed,
failed,
pending_review,
skipped
collection
string | null

The document's collection, if any.

metadata
Metadata · object

Filterable custom metadata attached to the document.

ingested_at
string<date-time> | null

When Hyperspell first indexed the document.

last_modified_at
string<date-time> | null

When the source document was last modified.

document_date
string<date-time> | null

The document's own date (e.g. email sent date, event date).