Try our new Setup Skill to automatically integrate Hyperspell into your project
API Documentation
Memories
Messages
Traces
Authentication
Daemon
Integrations
Connections
Folder Policies
Vault
Context Documents
- POSTGenerate a context document
- GETPreview available data for context document generation
- GETList context documents
- GETGet a context document
- POSTGenerate context docs folder structure in Google Drive
- POSTGenerate a three-tier context document tree
- GETGet the latest context document tree
- POSTPublish a draft context document tree
- POSTPublish a specific tier of a context document tree
- PATCHEdit files in a draft tree before publishing
- GETDiff a tree against the previous published tree
- GETCheck staleness of context documents
curl --request POST \
--url https://api.hyperspell.com/context-documents/tree \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sources": [
"<string>"
],
"user_id": "<string>",
"workstream_name": "<string>"
}
'{
"tree_id": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}Generate a three-tier context document tree
Generate a three-tier context document tree for local push delivery.
Creates company, workstream, and personal context docs from ALL ingested data (Gmail, Slack, Drive, Jira, etc.). Returns immediately with a tree_id — the daemon polls GET /tree/latest for the result.
No specific integration connection required — reads from synced resources in the database.
curl --request POST \
--url https://api.hyperspell.com/context-documents/tree \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sources": [
"<string>"
],
"user_id": "<string>",
"workstream_name": "<string>"
}
'{
"tree_id": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
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.
Body
Request body for POST /context-documents/tree.
Integration sources to include (e.g., ['gmail', 'slack']). Defaults to all.
User ID for personal tier scoping. When set, personal/context.md is generated from this user's data only. Company and team tiers still use all data.
Generate docs for this team only (skip auto-detection). Alias: team_name.
Was this page helpful?