GET
/
documents
/
get
/
{source}
/
{resource_id}
import Hyperspell from 'hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_TOKEN'], // This is the default and can be omitted
});

const document = await client.documents.get('collections', 'resource_id');

console.log(document.resource_id);
{
  "source": "collections",
  "resource_id": "<string>",
  "metadata": {
    "indexed_at": "2023-11-07T05:31:56Z",
    "last_modified": "2023-11-07T05:31:56Z",
    "status": "pending",
    "events": [
      {
        "message": "<string>",
        "time": "2023-11-07T05:31:56Z",
        "type": "error"
      }
    ]
  },
  "score": 123
}

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:
collections,
web_crawler,
notion,
slack,
google_calendar,
reddit,
box,
google_drive,
airtable,
algolia,
amplitude,
asana,
ashby,
bamboohr,
basecamp,
bubbles,
calendly,
confluence,
clickup,
datadog,
deel,
discord,
dropbox,
exa,
facebook,
front,
github,
gitlab,
google_docs,
google_mail,
google_sheet,
hubspot,
jira,
linear,
microsoft_teams,
mixpanel,
monday,
outlook,
perplexity,
rippling,
salesforce,
segment,
todoist,
twitter,
zoom
​
resource_id
string
required

Response

200
application/json

Successful Response

The response is of type object.