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
- GETList conflicts for the authenticated app
- POSTApprove or reject a pending conflict
- GETEvent log for a conflict
- POSTManually trigger conflict detection for a tree
- 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
- POSTPublish a COMPLETED tree (require_review flow)
- PATCHEdit files in a context document tree
- POSTRename a team — persists to config, applied on next regen
- GETList active team rename overrides
- DELClear a team rename override
- GETList persisted user edits for an app
- POSTLLM-based three-way merge of a user edit with the current LLM output
- POSTMark the user's decision on an edit — records which baseline they reviewed
- DELClear (soft-archive) a persisted edit
- GETDiff a tree against the previous tree
- GETCheck staleness of context documents
curl --request POST \
--url https://api.hyperspell.com/context-documents/tree/{tree_id}/publish \
--header 'Authorization: Bearer <token>'{
"tree_id": "<string>",
"status": "<string>",
"version": 123,
"files": [
{
"path": "<string>",
"content": "<string>",
"tier": "<string>",
"team": "<string>",
"updated_at": "<string>"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"meta": {}
}Publish a COMPLETED tree (require_review flow)
Promote a COMPLETED tree to PUBLISHED.
Only meaningful when the app has require_review=True. Apps without
require_review serve COMPLETED to the daemon directly and never need
to publish. Calling this on an app with require_review=False is still
allowed — the row gets stamped published_at/published_by — but it
has no functional effect on what the daemon serves.
Status guard: only COMPLETED can be published. PROCESSING means the workflow is still writing; FAILED has nothing to ship; PUBLISHED is a no-op (idempotent).
curl --request POST \
--url https://api.hyperspell.com/context-documents/tree/{tree_id}/publish \
--header 'Authorization: Bearer <token>'{
"tree_id": "<string>",
"status": "<string>",
"version": 123,
"files": [
{
"path": "<string>",
"content": "<string>",
"tier": "<string>",
"team": "<string>",
"updated_at": "<string>"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"meta": {}
}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
Was this page helpful?