Catalog & marketplace

The marketplace has three kinds of item: overlays (a design for a scene), widgets (one small live piece with settings, like a sub goal) and themes (a pack of overlays and widgets that go together, each for a scene such as starting, break or gameplay). You add items to your inventory, and the ForgeCast app runs them.

List predefined overlaysCopy Anchor Link

The predefined overlays. Widgets and themes are in the marketplace.

Query parameters

curl -s "$FORGECAST_URL/api/v1/catalog/overlays?category=starting" \
  -H "Authorization: Bearer $FORGECAST_KEY"

owned and available appear when you send a key: whether it's already in your inventory, and whether your plan lets you add it.

Get one overlayCopy Anchor Link

One overlay's metadata, as { "item": { ... } }. Its document is delivered through your inventory.

curl -s "$FORGECAST_URL/api/v1/catalog/overlays/midnight-forest" \
  -H "Authorization: Bearer $FORGECAST_KEY"

Browse the marketplaceCopy Anchor Link

Overlays, widgets and themes. Metadata only, never a document.

Query parameters

curl -s "$FORGECAST_URL/api/v1/market?kind=widget" \
  -H "Authorization: Bearer $FORGECAST_KEY"

Get one marketplace itemCopy Anchor Link

One item's metadata, as { "item": { ... } }.

curl -s "$FORGECAST_URL/api/v1/market/sub-goal" \
  -H "Authorization: Bearer $FORGECAST_KEY"

Preview an item's designCopy Anchor Link

The item's design, so a client can draw it before it's added. Credentials are required, and a caller whose plan can't add the item gets 403 plan_required and nothing of the design.

curl -s "$FORGECAST_URL/api/v1/market/sub-goal/preview" \
  -H "Authorization: Bearer $FORGECAST_KEY"

The document follows the overlay document format. A theme has members, one per part, each with its own document, kind and role.