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 tree generation progress
- GETGet the latest context document tree
- GETGet a specific context document tree by tree_id
- PATCHEdit files in a context document tree
- GETDiff a tree against the previous tree
- GETCheck staleness of context documents
curl --request GET \
--url https://api.hyperspell.com/context-documents/tree/{tree_id}/progress \
--header 'Authorization: Bearer <token>'{
"tree_id": "<string>",
"status": "<string>",
"phase": "<string>",
"completed_docs": 123,
"total_docs": 123
}Get tree generation progress
Return the generation progress for a single tree.
Live phase/counter data comes from the Temporal workflow query. Terminal trees and trees whose workflow is no longer queryable (e.g. completed workflows that have aged out, cron-driven refreshes) return just the DB-level status with no phase data.
curl --request GET \
--url https://api.hyperspell.com/context-documents/tree/{tree_id}/progress \
--header 'Authorization: Bearer <token>'{
"tree_id": "<string>",
"status": "<string>",
"phase": "<string>",
"completed_docs": 123,
"total_docs": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.hyperspell.com/llms.txt
Use this file to discover all available pages before exploring further.
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.
Path Parameters
Response
Successful Response
Response shape for GET /context-documents/tree/{tree_id}/progress.
Was this page helpful?