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.

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

Get tree generation progress

cURL

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

200

{
  "tree_id": "<string>",
  "status": "<string>",
  "phase": "<string>",
  "completed_docs": 123,
  "total_docs": 123
}

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

Response shape for GET /context-documents/tree/{tree_id}/progress.

tree_id · string · required

status · string · required

phase · string | null

Workflow phase. Values: discover, search, select, synthesize, finalize, done. Null for terminal trees and trees whose workflow is no longer queryable.

completed_docs · integer | null

total_docs · integer | null