IslesWikiNot officially affiliated with Isles

API reference

Upload a capture

Stores one capture file (what the mod saw in a menu) for the next snapshot. Only for holders of the sync service's upload token: this is how the mod shares what it captures.

Authorization

AuthorizationRequired

The sync service's upload token: Authorization: Bearer <upload token>. An API key is not an upload token.

Counted: 600 calls a minute per address without a key.

Request

Headers

AuthorizationstringRequired
Bearer and the sync service's upload token (not an API key).
Content-EncodingstringOptional
gzip, when the body is gzipped (up to 64 MB unpacked).
X-Capture-NamestringOptional
The file name to keep it under; the same name twice is stored once.

Request body

A capture file: an object with a stacks list, as the mod writes it.

Exampleapplication/json
{
  "title": "Smithing Station",
  "capturedAt": "2026-09-24T12:00:00Z",
  "stacks": [
    {
      "slot": 10,
      "item": "minecraft:iron_helmet",
      "name": "Leviahide Helmet",
      "…": "…"
    }
  ]
}

Response

201 Created: Stored; the snapshot is rebuilt a few seconds later.

201Createdapplication/json
{
  "stored": true,
  "name": "20260924-120000-smithing-station.json"
}

200 OK: A file with that name was already there.

200OKapplication/json
{
  "stored": false,
  "name": "20260924-120000-smithing-station.json"
}

Errors

  • 400bad captureThe body is not a capture (no stacks list).
  • 401bad tokenThe upload token is missing or wrong.
  • 401bad_keyAn API key was sent that is unknown or revoked. Leave it out to use the free limit.
  • 429rate_limitedMore than 600 uploads in a minute from one address.
  • 502unavailableThe sync service behind this route did not answer.