Docs/Artifacts

Artifacts · 4 min

Review HTML, Markdown, and small sites with your team

Publish a private file, collect comments on the page or a specific part, and send the thread back to Claude or Codex.

Publish it privately

Ask your coding agent
Publish the file or small site at <repo-relative path> with Brief’s publish_artifact tool. Keep it Restricted and return the Brief link and artifactId.

Brief returns one link, an artifact ID, and the first version. Restricted means only you can open it until you add people or change access.

Connect a coding agent to your workspace

Add the reviewers

  • Restricted: only you and people added by name can open it.
  • Workspace: any signed-in workspace member can open it.
  • Anyone with the link: no sign-in required. The link can expire or be revoked.
Ask your coding agent
Share artifact <artifactId> with <email address>. Keep general access Restricted and allow comments.

In Share, you can upload a custom link preview image. Brief crops PNG, JPG, or WebP files up to 2 MB to 1200 × 630. The image is public through an unguessable URL so preview apps can load it before access is checked, and they may keep a cached copy after access changes. Artifact access does not change; remove the image separately when needed.

Leave a comment

  • Open Comments, then choose Comment for feedback on the whole file.
  • Choose Select in file to attach feedback to text or an element. Repeat to attach up to six selections.
  • Reply in the thread. Resolve it when the change is done.

Comments stay with the version where they were made. Reviewers can also approve that version or request changes.

Type @ to notify someone in the workspace. The Artifacts bell shows mentions, replies, thread updates, and review decisions. Set it to All activity, Mentions & replies, or Off. Brief never notifies you about your own action.

Let the agent respond

Ask your coding agent
Call get_artifact_comments for <artifactId>. Read the open threads, update the source, then call update_artifact with the expectedVersion from the latest receipt. Return the same Brief link and the new version number.

get_artifact_comments returns comments on the page, selected text, and elements, along with replies, thread status, and review decisions.

  • Pass summary.nextCursor as after to read only activity since the previous check.
  • Use expectedVersion from the latest receipt when uploading the next version.
  • update_artifact keeps the same link and access settings.
Was this guide useful?Help us make Brief easier to learn.
Ready for another workflow?Choose your next mission →