Booth Wiki Booth Wiki
Pages

Wiki

Booth Wiki

UploadBooth

UploadBooth Documentation Service Comparison Matrix

UploadBooth API

UploadBooth API Documentation API Terms of Service api/authenticate api/change_password api/check_batch_password api/delete api/download api/edit api/info api/list api/order api/preview api/rename api/text HTTP Status Codes and Errors

Legal

Appatar Privacy Policy UploadBooth Terms of Service

api/download

Download an entire batch as a single zip archive.

URL:

Formats:

  • application/zip

HTTP Method:

  • GET

Parameters:

  • updated - unix timestamp. Requesting the URL without it issues a 302 redirect to the .zip URL with updated=<batch last-updated> appended; requesting the .zip URL with an updated timestamp serves the archive directly. The timestamp is a cache-buster: each batch revision gets a fresh URL, while the response itself is Cache-Control: max-age=0, must-revalidate.

  • password - required for password-protected batches. A wrong or missing password redirects to the batch’s password page instead of downloading (see api/check_batch_password).

Response:

  • 200 with the zip on disk (Content-Disposition: attachment, named <batch>.zip). The archive contains all batch files plus an UPLOADBOOTH.txt with the api/text batch info.

  • 302 redirect to the canonical .zip URL (or to the password page for protected batches).

  • JSON error envelope (HTTP 200, type = error) for unknown users (Unknown user) and unknown batches (Batch not found.).