Get the latest context document tree

Get the most recent context document tree for the authenticated app.

The sync daemon polls this endpoint to fetch updated files. Default behaviour: serve the latest “ready” tree, where “ready” depends on whether the app has require_review enabled:

• require_review=False (default): latest COMPLETED ships immediately.
• require_review=True: latest PUBLISHED only — apps that gate on a curator’s approval before the daemon picks up the new tree.

?status=<value> filters to a specific status (case-insensitive). ?include_published=true returns the absolute latest tree (any status) so the dashboard can surface an in-flight PROCESSING generation when the user navigates away mid-gen and back. The daemon path (no include_published) keeps strict status filtering.

GET /context-documents/tree/latest

Get the latest context document tree

cURL

curl --request GET \
  --url https://api.hyperspell.com/context-documents/tree/latest \
  --header 'Authorization: Bearer <token>'

200

{
  "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": {}
}

Authorizations

APIKeyAsUser

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.

Query Parameters

status · string | null

include_published · boolean · default: false

Response

200

application/json

Successful Response

tree_id · string · required

status · string · required

version · integer · required

files · TreeFile · object[] | null · required

Show child attributes

error · string | null · required

created_at · string<date-time> · required

completed_at · string<date-time> | null · required

meta · Meta · object · required