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).

POST /context-documents/tree/{tree_id}/publish

Publish a COMPLETED tree (require_review flow)

cURL

curl --request POST \
  --url https://api.hyperspell.com/context-documents/tree/{tree_id}/publish \
  --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.

Path Parameters

tree_id · string · required

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