Get archives that don't have any tags recorded. This follows the same rules as the Batch Tagging filter and will include archives that have parody:, date_added:, series: or artist: tags.
Get a Thumbnail image for a given Archive. This endpoint will return a placeholder image if it doesn't already exist.
If you want to queue generation of the thumbnail in the background, you can use the no_fallback query parameter. This will give you a background job ID instead of the placeholder.
Path Parameters
Name
Type
Description
id*
string
ID of the Archive to process.
Query Parameters
Name
Type
Description
page
int
Specify which page you want to get a thumbnail for. Defaults to the cover, aka page 1.
no_fallback
boolean
Disables the placeholder image, queues the thumbnail for extraction and returns a JSON with code 202.
This parameter does nothing if the image already exists. (You will get the image with code 200 no matter what)
Create thumbnails for every page of a given Archive. This endpoint will queue generation of the thumbnails in the background.
If all thumbnails are detected as already existing, the call will return HTTP code 200.
This endpoint can be called multiple times -- If a thumbnailing job is already in progress for the given ID, it'll just give you the ID for that ongoing job.
Path Parameters
Name
Type
Description
id*
string
ID of the Archive to process.
Query Parameters
Name
Type
Description
force
boolean
Whether to force regeneration of all thumbnails even if they already exist.
Get a list of URLs pointing to the images contained in an archive. If necessary, this endpoint also launches a background Minion job to extract the archive so it is ready for reading.
Path Parameters
Name
Type
Description
id*
string
ID of the Archive to process.
Query Parameters
Name
Type
Description
force
bool
Force a full background re-extraction of the Archive.
Existing cached files might still be used in subsequent /api/archives/:id/page calls until the Archive is fully re-extracted.
Tell the server which page of this Archive you're currently showing/reading, so that it updates its internal reading progression accordingly.
This endpoint will also update the date this Archive was last read, using the current server timestamp.
You should call this endpoint only when you're sure the user is currently reading the page you present.
Don't use it when preloading images off the server.
Whether to make reading progression regressible or not is up to the client. (The web client will reduce progression if the user starts reading previous pages)
Consider however removing the "New!" flag from an archive when you start updating its progress - The web client won't display any reading progression if the new flag is still set.
⚠ If the server is configured to use clientside progress tracking, this API call will return an error!
Make sure to check using /api/info whether the server tracks reading progression or not before calling this endpoint.
Path Parameters
Name
Type
Description
id*
string
ID of the Archive to process
page*
int
Current page to update the reading progress to. Must be a positive integer, and inferior or equal to the total page number of the archive.
{"operation": "update_progress","error": "No archive ID specified.","success": 0}{"operation": "update_progress","error": "Server-side Progress Tracking is disabled on this instance.","success": 0}{"operation": "update_progress","error": "Invalid progress value.","success": 0}{"operation": "update_progress","error": "Archive doesn't have a total page count recorded yet.","success": 0}
🔑Upload Archive
PUThttp://lrr.tvc-16.science/api/archives/upload
Upload an Archive to the server. If a SHA1 checksum of the Archive is included, the server will perform an optional in-transit, file integrity validation, and reject the upload if the server-side checksum does not match.
Query Parameters
Name
Type
Description
title
string
Title of the Archive.
tags
string
Set of tags you want to insert in the database alongside the archive.
summary
string
summary
category_id
int
Category ID you'd want the archive to be added to.
file_checksum
string
SHA1 checksum of the archive for in-transit validation.
{"operation": "upload","error": "No file attached","success": 0}
{"operation": "upload","error": "This file already exists in the Library. Enable replace duplicated archive in config to replace old ones.","success": 0,"id": "0b91b546850e881034833c73375558928ddcec7c"}
