renza

API reference

Artifacts

The stored, immutable HTML versions of a deck. A deck points at its current artifact; rolling back is pointing it at an older one. Artifact HTML is always served from the isolated content origin, never from the API.

Related guides: Comments & versions

Attributes

  • idstringrequired
  • objectstringrequired
  • deckstringrequired
  • doc_typestringrequired

    Possible values: deck, freeform

  • slide_selectorstring | nullrequired
  • active_classstringrequired
  • slide_countintegerrequired
  • content_hashstringrequired
  • self_chromedbooleanrequired
  • self_chrome_signalsarray of stringrequired
  • livemodebooleanrequired
  • created_attimestamprequired

List artifacts

GET/v1/artifacts

Lists artifacts in the active org, newest first. Filter to one deck with `deck`.

Requires an API key (bearer), scoped to the active org.

Query parameters

  • limitintegeroptionaldefault 201–100
  • cursorstringoptional
  • orderstringoptionaldefault "created_at.desc"

    Possible values: created_at.desc, created_at.asc

  • deckstringoptional

Returns

  • 200A page of artifacts.

Failures use the standard error envelope with a closed set of codes.

Retrieve an artifact

GET/v1/artifacts/{id}

Fetches an artifact's metadata by id. The HTML is served only from the content origin.

Requires an API key (bearer), scoped to the active org.

Path parameters

  • idstringrequired

Returns

  • 200The artifact.

Failures use the standard error envelope with a closed set of codes.

Retrieve an artifact's HTML (for editing)

GET/v1/artifacts/{id}/content

Returns the entry HTML as a data string for the authed owner — the read half of the BYO-AI edit round-trip. Pair with `GET /v1/slides?artifact=` for the sacred anchor ids to preserve, then re-publish as a new version. Served as JSON (never text/html), so it is not a rendered page (05).

Requires an API key (bearer), scoped to the active org.

Path parameters

  • idstringrequired

Returns

  • 200The artifact's entry HTML.

Failures use the standard error envelope with a closed set of codes.