Skip to content

Fix the artifact archive method and document the quality route #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abhishekgahlot2 merged 1 commit into from
Nov 2, 2026
Merged

Fix the artifact archive method and document the quality route #404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs-site/docs/api/artifacts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ immutable bytes and authorization. All routes are org-session scoped. See
| GET | `/api/artifacts/:id` | Fetch an artifact descriptor. | `{artifact}`. `404 not found`. |
| GET | `/api/artifacts/:id/content` | Stream artifact bytes (range-capable). | Query `download=1` forces attachment. Honors `Range`; `200` or `206`, `416` on a bad range, `410` when bytes are unavailable. `HEAD` is also served (headers only). |
| GET | `/api/artifacts/:id/preview` | Rendered-PDF preview of an Office binary, inline. | `application/pdf`, `cache-control: private, max-age=300`. `404` no preview, `410` unavailable. |
| GET | `/api/artifacts/:id/quality` | The quality check result for the artifact's current revision. | `{status:"unverified", artifactRevision, subjectDigest}` with no receipt for that revision, or `{status:"verified", receipt}` where `receipt` has `id`, `artifactId`, `threadId`, `artifactRevision`, `subjectDigest`, `qualityProfile`, `exportFormat`, `exportDigest`, `visualDigest`, `inspectorVersion`, `createdAt`. `404 not found`. |
| GET | `/api/artifacts/:id/workpiece` | The workpiece descriptor plus canonical (upgraded) state. | `{workpiece, state}`. `404` when the artifact is not a workpiece. |
| PATCH | `/api/artifacts/:id/workpiece` | Update the workpiece state (optimistic concurrency). | Body: `expected_revision` (non-negative integer, required), `state` (parsed for the workpiece kind). `409 revision conflict` on a stale revision. |
| GET | `/api/artifacts/:id/workpiece/export` | Export the workpiece to a downloadable file. | Query `format`. `409 invalid stored workpiece state` when canonicalization fails. |
Expand Down
2 changes: 1 addition & 1 deletion docs-site/docs/product/artifacts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ its detail and, for a workpiece, an inline editor.
| Fetch, content | `GET /api/artifacts/:id`, `/:id/content` |
| Preview | `GET /api/artifacts/:id/preview` |
| Workpiece, export | `/:id/workpiece`, `/:id/workpiece/export` |
| Archive a run's artifacts | `POST /api/artifacts/runs/:runId/archive` |
| Archive a run's artifacts | `GET /api/artifacts/runs/:runId/archive` |

## Workpieces

Expand Down
Loading