Skip to content
ForgeCastDocs

Pictures

List the pictures in your library that overlays show, upload new ones and delete old ones.

Pictures you upload live in your library and are served from the website, so overlays (yours, and items you publish in the marketplace) can show them.

EndpointScopePlan
GET /assetsassets:readAny
POST /assets, DELETE /assets/:idassets:writeUploading needs Pro or Ultimate

List your pictures

GET/api/v1/assetsassets:read

Newest first, each with how many of your overlays use it, and how much of your plan's allowance they take.

{
  "items": [
    { "id": "8c3f…", "name": "logo.png", "mime": "image/png", "bytes": 48213, "width": 512, "height": 512, "url": "https://forgecast.in/assets/8c3f…", "createdAt": "2026-10-18T09:00:00.000Z", "usedIn": 2 }
  ],
  "usage": { "bytes": 48213, "files": 1, "maxBytes": 104857600, "maxFiles": 200 }
}

Upload a picture

POST/api/v1/assetsassets:write

Send the picture's bytes as the body: PNG, JPG, GIF or WebP, up to 5 MB. Put its name in the X-File-Name header (URI-encoded).

curl -s -X POST "$FORGECAST_URL/api/v1/assets" \
  -H "Authorization: Bearer $FORGECAST_KEY" \
  -H "Content-Type: image/png" \
  -H "X-File-Name: logo.png" \
  --data-binary @logo.png

Answers 201 { "asset": … }. Uploading the same picture again returns the one you already have (200) instead of storing a copy. At most 20 uploads a minute; over your plan's allowance it's 403.

Delete a picture

DELETE/api/v1/assets/:idassets:write

204. Overlays that showed it show nothing in its place. A picture shown by an item you published in the marketplace can't be deleted (409 conflict) until the item is taken down.

On this page