Skip to main content

Reference Artifact

The reference artifact represents an external or supporting reference item. Use references for URLs, citations, supporting notes, or material that informs workspace work.

When To Use This Kind

  • Choose this kind when the artifact's meaning matches the operational object, not merely because of a file extension.
  • Attach source or rendered files as blobs when the artifact has file-backed content.
  • Link this artifact to sources, outputs, operations, and related context so reviewers can follow the evidence chain.

Data Contract

Kind data contract: ReferenceData with fields url, resolved_url, site_name, favicon_url, preview_image_url, social.

Common artifact fields still apply: title, summary, status, visibility, metadata, blobs, links, and events.

Review Checklist

  • Confirm the artifact kind matches what the team needs to review.
  • Check available blobs before assuming source or rendered content exists.
  • Follow links to understand provenance and downstream outputs.
  • Review events for creation, updates, renders, tool work, and failures.

Media To Add

  • Screenshot: reference artifact detail page with kind data, blobs, links, and events labeled. It helps readers understand how this artifact appears in the app. Source: sample workspace artifact of this kind.