Archive API
Everything dealing with Archives.
Get all Archives
GET
http://lrr.tvc-16.science/api/archives
Get the Archive Index in JSON form. You can use the IDs of this JSON with the other endpoints.
Get Untagged Archives
GET
http://lrr.tvc-16.science/api/archives/untagged
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 Archive Metadata
GET
http://lrr.tvc-16.science/api/archives/:id/metadata
Get Metadata (title, tags) for a given Archive.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to process. |
Get Archive Categories
GET
http://lrr.tvc-16.science/api/archives/:id/categories
Get all the Categories which currently refer to this Archive ID.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to process. |
Get Archive Tankoubons
GET
http://lrr.tvc-16.science/api/archives/:id/tankoubons
Get all the Tankoubons which currently refer to this Archive ID.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to process. |
Get Archive Thumbnail
GET
http://lrr.tvc-16.science/api/archives/:id/thumbnail
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) |
Queue extraction of page thumbnails
POST
http://lrr.tvc-16.science/api/archives/:id/files/thumbnails
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. |
Download an Archive
GET
http://lrr.tvc-16.science/api/archives/:id/download
Download an Archive from the server.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to download. |
Extract an Archive
GET
http://lrr.tvc-16.science/api/archives/:id/files
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 |
Clear Archive New flag
DELETE
http://lrr.tvc-16.science/api/archives/:id/isnew
Clears the "New!" flag on an archive.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to process |
Update Reading Progression
PUT
http://lrr.tvc-16.science/api/archives/:id/progress/:page
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. |
πUpdate Thumbnail
PUT
http://lrr.tvc-16.science/api/archives/:id/thumbnail
Update the cover thumbnail for the given Archive. You can specify a page number to use as the thumbnail, or you can use the default thumbnail.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to process. |
page | int | Page you want to make the thumbnail out of. Defaults to 1. |
πUpdate Archive Metadata
PUT
http://lrr.tvc-16.science/api/archives/:id/metadata
Update tags and title for the given Archive. Data supplied to the server through this method will overwrite the previous data.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to process. |
Query Parameters
Name | Type | Description |
---|---|---|
title | string | New Title of the Archive. |
tags | string | New Tags of the Archive. |
summary | string | New Summary of the Archive. |
πDelete Archive
DELETE
http://lrr.tvc-16.science/api/archives/:id
Delete both the archive metadata and the file stored on the server. π Please ask your user for confirmation before invoking this endpoint.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | ID of the Archive to process. |
Last updated