Read per-reviewer progress for a PR, branch document, or draft review.
GET /api/v1/review/progress
Agents can read progress but cannot mutate human review progress through the external API.
Access
Section titled “Access”Use a credential with commentary.review.read.
Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.
Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
provider |
query | "github" |
No | |
owner |
query | string | No | |
repo |
query | string | No | |
draftSessionId |
query | string | No | |
file |
query | array of string | No | Repeat for one or more file paths. |
pr |
query | integer | No | |
branch |
query | string | No | |
revision |
query | string | No | |
X-Commentary-Workspace-Id |
header | string | No | Must match the credential workspace. This header cannot widen grant authority. |
X-Correlation-Id |
header | string | No |
Call the endpoint
Section titled “Call the endpoint”Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.
curl --request GET \ 'https://commentary.dev/api/v1/review/progress' \ --header 'Authorization: Bearer <your-token>'Responses
Section titled “Responses”| Status | Meaning | Payload |
|---|---|---|
200 |
Successful response. | ReviewProgressResponse |
400 |
The request was invalid. | ExternalError |
401 |
Authentication is required. | ExternalError |
403 |
The token or session does not have permission for this resource. | ExternalError |
404 |
The resource was not found. | ExternalError |
429 |
The request was rate limited. | ExternalError |
Successful response fields
Section titled “Successful response fields”| Field | Type | Required | Description |
|---|---|---|---|
ok |
true |
Yes | |
viewerScoped |
boolean | Yes | |
summary |
ReviewProgressSummary | Yes | |
files |
array of ReviewProgressFile | Yes |
Recover from errors
Section titled “Recover from errors”Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.
Contract and related guidance
Section titled “Contract and related guidance”Operation ID: getReviewProgress. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.