---
title: "Get tree generation progress"
method: GET
path: "/context-documents/tree/{tree_id}/progress"
tags: ["Context Documents"]
---

# Get tree generation progress

`GET /context-documents/tree/{tree_id}/progress`

Return the generation progress for a single tree.

Temporal-backed trees expose live phase/counter data via workflow query.
Legacy BackgroundTask trees surface the textual progress message they
wrote into `tree.meta.progress`.

## Path parameters

- `tree_id` string, required

## Response `200`

Successful Response

- TreeProgressResponse — Response shape for GET /context-documents/tree/{tree_id}/progress.
  - `tree_id` string, required
  - `status` string, required
  - `phase` string, nullable — Workflow phase (discover/generate/finalize/done) when Temporal-gated.
  - `completed_docs` integer, nullable
  - `total_docs` integer, nullable
  - `message` string, nullable

## Other responses

- `422` — Validation Error

## Changes

- **2026-04-25** `0b9bf804b7e6` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/hyperspell/apis/hyperspell-api/changes/context-documents/tree/:tree_id/progress/get.md)

---

[API](https://skmtc.dev/hyperspell/apis/hyperspell-api.md) · [All operations](https://skmtc.dev/hyperspell/apis/hyperspell-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperspell/hyperspell-api/revisions/023174b0253c/schema)
