Inventory

An inventory item is either a predefined overlay you added (kind: "template") or an overlay you created (kind: "custom"). Owning an item is what lets the ForgeCast app run it.

List your inventoryCopy Anchor Link

Newest first. Metadata only, no documents.

Query parameters

curl -s "$FORGECAST_URL/api/v1/inventory?limit=25" \
  -H "Authorization: Bearer $FORGECAST_KEY"

Read one itemCopy Anchor Link

One item with its overlay document (see the overlay document format), as { "item": { ... } }.

curl -s "$FORGECAST_URL/api/v1/inventory/9a7e..." \
  -H "Authorization: Bearer $FORGECAST_KEY"

Add an itemCopy Anchor Link

Add a predefined overlay by its slug or templateId, or a marketplace item by its slug. Adding a theme adds the theme as one item. It's idempotent: 201 when added, 200 if you already had it.

Body: send one of the two.

curl -s -X POST "$FORGECAST_URL/api/v1/inventory" \
  -H "Authorization: Bearer $FORGECAST_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "slug": "midnight-forest" }'

Errors: 403 plan_required (the item needs a higher plan), 403 limit_reached (inventory full), 404.

Remove an itemCopy Anchor Link

Always allowed, even if the item is locked. Returns 204.

curl -s -X DELETE "$FORGECAST_URL/api/v1/inventory/9a7e..." \
  -H "Authorization: Bearer $FORGECAST_KEY"