Share a deck

POST/v1/shares

Mints a share token (link or public) for a deck and sets the deck's share mode. Anyone with the resulting link can view — no account needed.

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

Body parameters

deckstringrequired
Deck id or external_id.
modestringoptional
Possible values: link, public
expires_in_daysintegeroptional1–365
Link stops resolving after this many days (Renza Pro).
passwordstringoptionalmax 72 chars
Viewers must enter this before the deck serves (Renza Pro). Stored hashed.

Returns

201The created share.

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

Terminal

renza shares create deck_2a9f8c1b --mode link

POST /v1/shares

curl https://api.renza.io/v1/shares \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "deck": "deck_2a9f8c1b",
  "mode": "link",
  "expires_in_days": 30
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

const renza = createRenzaClient({ apiKey: process.env.RENZA_API_KEY! });

const share = await renza.shares.create({
  deck: "deck_2a9f8c1b",
  mode: "link",
  expires_in_days: 30,
});

Response 201

{
  "id": "shr_7a2c…",
  "object": "share",
  "token": "X3k9...x",
  "deck": "deck_2a9f8c1b",
  "mode": "link",
  "url": "https://renza.io/v/X3k9…x",
  "expires_at": null,
  "revoked_at": null,
  "created_at": "2026-06-19T10:30:00.000Z"
}