Try our new Claude Code Skill to automatically integrate Hyperspell into your project
import Hyperspell from 'hyperspell';
const client = new Hyperspell({
apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});
const response = await client.auth.me();
console.log(response.id);{
"id": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"icon_url": "<string>",
"redirect_url": "<string>"
},
"available_integrations": [
"collections"
],
"installed_integrations": [
"collections"
],
"token_expiration": "2023-11-07T05:31:56Z"
}Endpoint to get basic user data.
import Hyperspell from 'hyperspell';
const client = new Hyperspell({
apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});
const response = await client.auth.me();
console.log(response.id);{
"id": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"icon_url": "<string>",
"redirect_url": "<string>"
},
"available_integrations": [
"collections"
],
"installed_integrations": [
"collections"
],
"token_expiration": "2023-11-07T05:31:56Z"
}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.
Successful Response
The user's id
The Hyperspell app's id this user belongs to
Show child attributes
All integrations available for the app
collections, reddit, notion, slack, google_calendar, google_mail, box, google_drive, vault, web_crawler All integrations installed for the user
collections, reddit, notion, slack, google_calendar, google_mail, box, google_drive, vault, web_crawler The expiration time of the user token used to make the request
Was this page helpful?