docs: document shareable media artifact links and artifact media pages - #480
docs: document shareable media artifact links and artifact media pages#480hongyi-chen wants to merge 2 commits into
Conversation
Cover the agent's ability to share Computer Use screenshots and recordings outside pull requests, and the per-artifact media page in the Oz web app that those links open. Co-Authored-By: Oz <oz-agent@warp.dev> Co-Authored-By: Warp Agent <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
There was a problem hiding this comment.
Overview
This PR documents shareable Computer Use media artifact links and the per-artifact media page in the Oz web app, and updates the existing pull request attachment wording to match the new link target.
Concerns
- One non-blocking docs style issue: avoid hardcoding the Oz web app host in body prose when the page already uses the shared variable system.
Verdict
Found: 0 critical, 0 important, 1 suggestions
Approve with nits
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
|
|
||
| A pull request isn't always where the evidence belongs. When an agent posts to Slack, comments on an issue or pull request, updates a Linear issue, or answers you in chat, it can pull shareable links for the screenshots and recordings the run captured and include the relevant ones in that message. | ||
|
|
||
| Each link opens a media page in the {VARS.WEB_APP} that shows one capture — for example, `https://oz.warp.dev/artifacts/ARTIFACT_UID`, where `ARTIFACT_UID` identifies the screenshot or recording. Access is checked when the link is opened, so a link is safe to paste into an external tool: viewers who can't access the run are asked to sign in and are turned away if they lack permission. |
There was a problem hiding this comment.
💡 [SUGGESTION] Avoid hardcoding oz.warp.dev; this page already imports VARS, so referencing the route keeps the copy resilient to web app URL changes.
| Each link opens a media page in the {VARS.WEB_APP} that shows one capture — for example, `https://oz.warp.dev/artifacts/ARTIFACT_UID`, where `ARTIFACT_UID` identifies the screenshot or recording. Access is checked when the link is opened, so a link is safe to paste into an external tool: viewers who can't access the run are asked to sign in and are turned away if they lack permission. | |
| Each link opens a media page in the {VARS.WEB_APP} that shows one capture. The URL uses the `/artifacts/<artifact-uid>` path, where `<artifact-uid>` identifies the screenshot or recording. Access is checked when the link is opened, so a link is safe to paste into an external tool: viewers who can't access the run are asked to sign in and are turned away if they lack permission. |
Summary
A
missing_docsdrift-watch run detected two new surfaces that ship the same user-facing capability and had no docs coverage:get_media_artifact_links, which returns shareable links to a run's Computer Use screenshots and video recordings so an agent can include them in a Slack message, an issue or PR comment, a Linear comment, or a chat reply.artifacts/:artifactUid, the per-artifact media page those links open.Both are enabled in production (
media_artifact_links_toolandartifact_media_page_linksinconfig/prod.yaml). The same rollout also changed what Link only attachments point at: PR links now open the artifact's media page rather than the run page, so the existing wording on the artifacts page was stale.Changes
src/content/docs/agents/capabilities/computer-use/artifacts-in-prs.mdx
src/content/docs/platform/oz-web-app.mdx
/artifacts/<artifact-uid>page and its access behavior.Source of truth
logic/ai/multi_agent/runtime/get_media_artifact_links.go— link building, attachment-mode gating, embed URLs and video thumbnails.logic/ai/multi_agent/artifact_attachments/media_page_links.go—MediaPageArtifactURL(<oz origin>/artifacts/<uuid>).client/packages/agents/src/pages/Artifacts/index.tsx— public media viewer; public artifacts render without auth, private ones redirect to login.Validation
npm run buildpasses.check_links.pyreports 0 broken links (including the new#artifact-media-pagesanchor).Deferred findings from this audit run
Summarized in full in the companion audit-bookkeeping PR:
GET /agent/artifacts/{artifactUid}/download,GET /agent/run-by-external-reference,POST /agent/runs/{runId}/scores) — belongs to thesync-openapi-specskill, and the regenerated subset would also pull in research-preview Agent Memory schemas, which needs a policy decision first.GET /factory/{uid}/metrics— mapped internal (unreleased product /x-internalin the canonical spec).Co-Authored-By: Oz oz-agent@warp.dev
Co-Authored-By: Warp Agent agent@warp.dev