Skip to main content

Client API

client api

The hydrus client now supports a very simple API so you can access it with external programs.

By default, the Client API is not turned on. Go to services->manage services and give it a port to get it started. I recommend you not allow non-local connections (i.e. only requests from the same computer will work) to start with.

The Client API should start immediately. It will only be active while the client is open. To test it is running all correct (and assuming you used the default port of 45869), try loading this:

http://127.0.0.1:45869

You should get a welcome page. By default, the Client API is HTTP, which means it is ok for communication on the same computer or across your home network (e.g. your computer's web browser talking to your computer's hydrus), but not secure for transmission across the internet (e.g. your phone to your home computer). You can turn on HTTPS, but due to technical complexities it will give itself a self-signed 'certificate', so the security is good but imperfect, and whatever is talking to it (e.g. your web browser looking at https://127.0.0.1:45869) may need to add an exception.

The Client API is still experimental and sometimes not user friendly. If you want to talk to your home computer across the internet, you will need some networking experience. You'll need a static IP or reverse proxy service or dynamic domain solution like no-ip.org so your device can locate it, and potentially port-forwarding on your router to expose the port. If you have a way of hosting a domain and have a signed certificate (e.g. from Let's Encrypt), you can overwrite the client.crt and client.key files in your 'db' directory and HTTPS hydrus should host with those.

Once the API is running, go to its entry in services->review services. Each external program trying to access the API will need its own access key, which is the familiar 64-character hexadecimal used in many places in hydrus. You can enter the details manually from the review services panel and then copy/paste the key to your external program, or the program may have the ability to request its own access while a mini-dialog launched from the review services panel waits to catch the request.

Browsers and tools created by hydrus users:

Library modules created by hydrus users:

API

On 200 OK, the API returns JSON for everything except actual file/thumbnail requests. On 4XX and 5XX, assume it will return plain text, sometimes a raw traceback. You'll typically get 400 for a missing parameter, 401/403/419 for missing/insufficient/expired access, and 500 for a real deal serverside error.

Access and permissions

The client gives access to its API through different 'access keys', which are the typical 64-character hex used in many other places across hydrus. Each guarantees different permissions such as handling files or tags. Most of the time, a user will provide full access, but do not assume this. If the access header or parameter is not provided, you will get 401, and all insufficient permission problems will return 403 with appropriate error text.

Access is required for every request. You can provide this as an http header, like so:

  • Hydrus-Client-API-Access-Key : 0150d9c4f6a6d2082534a997f4588dcf0c56dffe1d03ffbf98472236112236ae

Or you can include it as a GET or POST parameter on any request (except POST /add_files/add_file, which uses the entire POST body for the file's bytes). Use the same name for your GET or POST argument, such as:

  • /get_files/thumbnail?file_id=452158&Hydrus-Client-API-Access-Key=0150d9c4f6a6d2082534a997f4588dcf0c56dffe1d03ffbf98472236112236ae

There is now a simple 'session' system, where you can get a temporary key that gives the same access without having to include the permanent access key in every request. You can fetch a session key with the /session_key command and thereafter use it just as you would an access key, just with Hydrus-Client-API-Session-Key instead.

Session keys will expire if they are not used within 24 hours, or if the client is restarted, or if the underlying access key is deleted. An invalid/expired session key will give a 419 result with an appropriate error text.

Bear in mind the Client API is still under construction and is http-only for the moment--be careful about transmitting sensitive content outside of localhost. The access key will be unencrypted across any connection, and if it is included as a GET parameter, as simple and convenient as that is, it could be cached in all sorts of places.

Access Management

GET /api_version

Gets the current API version. I will increment this every time I alter the API.

  • Restricted access: NO.

  • Required Headers: n/a

  • Arguments: n/a

  • Response description: Some simple JSON describing the current version.

  • Example response:

    • {"version" : 1}

GET /request_new_permissions

Register a new external program with the client. This requires the 'add from api request' mini-dialog under services->review services to be open, otherwise it will 403.

  • Restricted access: NO.

  • Required Headers: n/a

  • Arguments:

    • name : (descriptive name of your access)
    • basic_permissions : A JSON-encoded list of numerical permission identifiers you want to request.

  • The permissions are currently:

    • 0 - Import URLs
    • 1 - Import Files
    • 2 - Add Tags
    • 3 - Search for Files
    • 4 - Manage Pages
    • 5 - Manage Cookies

  • Example request:

    • /request_new_permissions?name=my%20import%20script&basic_permissions=[0,1]

  • Response description: Some JSON with your access key, which is 64 characters of hex. This will not be valid until the user approves the request in the client ui.

  • Example response:

    • {"access_key" : "73c9ab12751dcf3368f028d3abbe1d8e2a3a48d0de25e64f3a8f00f3a1424c57"}

GET /session_key

Get a new session key.

  • Restricted access: YES. No permissions required.

  • Required Headers: n/a

  • Arguments: n/a

  • Response description: Some JSON with a new session key in hex.

  • Example response:

    • {"session_key" : "f6e651e7467255ade6f7c66050f3d595ff06d6f3d3693a3a6fb1a9c2b278f800"}

  • Note that the access you provide to get a new session key can be a session key, if that happens to be useful. As long as you have some kind of access, you can generate a new session key.

    A session key expires after 24 hours of inactivity, whenever the client restarts, or if the underlying access key is deleted. A request on an expired session key returns 419.

GET /verify_access_key

Check your access key is valid.

  • Restricted access: YES. No permissions required.

  • Required Headers: n/a

  • Arguments: n/a

  • Response description: 401/403/419 and some error text if the provided access/session key is invalid, otherwise some JSON with basic permission info.

  • Example response:

    • {
	"basic_permissions" : [0, 1, 3],
	"human_description" : "API Permissions (autotagger): add tags to files, import files, search for files: Can search: only autotag this"
}

Adding Files

POST /add_files/add_file

Tell the client to import a file.

  • Restricted access: YES. Import Files permission needed.

  • Required Headers:

    • Content-Type : application/json (if sending path), application/octet-stream (if sending file)

  • Arguments (in JSON):

path : (the path you want to import)

  • Example request body:

    {"path" : "E:\\to_import\\ayanami.jpg"}

  • Arguments (as bytes): You can alternately just send the file's bytes as the POST body.

  • Response description: Some JSON with the import result. Please note that file imports for large files may take several seconds, and longer if the client is busy doing other db work, so make sure your request is willing to wait that long for the response.

  • Example response:

    {
	"status" : 1,
	"hash" : "29a15ad0c035c0a0e86e2591660207db64b10777ced76565a695102a481c3dd1",
	"note" : ""
}

    'status' is:

    • 1 - File was successfully imported
    • 2 - File already in database
    • 3 - File previously deleted
    • 4 - File failed to import
    • 7 - File vetoed

    A file 'veto' is caused by the file import options (which in this case is the 'quiet' set under the client's options->importing) stopping the file due to its resolution or minimum file size rules, etc...

    'hash' is the file's SHA256 hash in hexadecimal, and 'note' is some occasional additional human-readable text appropriate to the file status that you may recognise from hydrus's normal import workflow. For an import error, it will always be the full traceback.

POST /add_files/delete_files

Tell the client to send files to the trash.

  • Restricted access: YES. Import Files permission needed.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • hash : (an SHA256 hash for a file in 64 characters of hexadecimal)
    • hashes : (a list of SHA256 hashes)

  • Example request body:

    {"hash" : "78f92ba4a786225ee2a1236efa6b7dc81dd729faf4af99f96f3e20bad6d8b538"}

  • Response description: 200 and no content.

  • You can use hash or hashes, whichever is more convenient.

    At the moment, this is only able to send files from 'my files' to the trash, and so it cannot perform physical deletes. There is no error if any files do not currently exist in 'my files'. In future, it will take some sort of file service parameter to do more.

POST /add_files/undelete_files

Tell the client to pull files back out of the trash.

  • Restricted access: YES. Import Files permission needed.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • hash : (an SHA256 hash for a file in 64 characters of hexadecimal)
    • hashes : (a list of SHA256 hashes)

  • Example request body:

    {"hash" : "78f92ba4a786225ee2a1236efa6b7dc81dd729faf4af99f96f3e20bad6d8b538"}

  • Response description: 200 and no content.

  • You can use hash or hashes, whichever is more convenient.

    This is just the reverse of a delete_files--removing files from trash and putting them back in 'my files'. There is no error if any files do not currently exist in 'trash'.

POST /add_files/archive_files

Tell the client to archive inboxed files.

  • Restricted access: YES. Import Files permission needed.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • hash : (an SHA256 hash for a file in 64 characters of hexadecimal)
    • hashes : (a list of SHA256 hashes)

  • Example request body:

    {"hash" : "78f92ba4a786225ee2a1236efa6b7dc81dd729faf4af99f96f3e20bad6d8b538"}

  • Response description: 200 and no content.

  • You can use hash or hashes, whichever is more convenient.

    This puts files in the 'archive', taking them out of the inbox. It only has meaning for files currently in 'my files' or 'trash'. There is no error if any files do not currently exist or are already in the archive.

POST /add_files/unarchive_files

Tell the client re-inbox archived files.

  • Restricted access: YES. Import Files permission needed.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • hash : (an SHA256 hash for a file in 64 characters of hexadecimal)
    • hashes : (a list of SHA256 hashes)

  • Example request body:

    {"hash" : "78f92ba4a786225ee2a1236efa6b7dc81dd729faf4af99f96f3e20bad6d8b538"}

  • Response description: 200 and no content.

  • You can use hash or hashes, whichever is more convenient.

    This puts files back in the inbox, taking them out of the archive. It only has meaning for files currently in 'my files' or 'trash'. There is no error if any files do not currently exist or are already in the inbox.

Adding Tags

GET /add_tags/clean_tags

Ask the client about how it will see certain tags.

  • Restricted access: YES. Add Tags permission needed.

  • Required Headers: n/a

  • Arguments (in percent-encoded JSON):

    • tags : (a list of the tags you want cleaned)

  • Example request:

    Given tags [ " bikini ", "blue    eyes", " character : samus aran ", ":)", "   ", "", "10", "11", "9", "system:wew", "-flower" ]:

    • /add_tags/clean_tags?tags=%5B%22%20bikini%20%22%2C%20%22blue%20%20%20%20eyes%22%2C%20%22%20character%20%3A%20samus%20aran%20%22%2C%20%22%3A%29%22%2C%20%22%20%20%20%22%2C%20%22%22%2C%20%2210%22%2C%20%2211%22%2C%20%229%22%2C%20%22system%3Awew%22%2C%20%22-flower%22%5D

  • Response description: The tags cleaned according to hydrus rules. They will also be in hydrus human-friendly sorting order.

  • Example response:

    • {
	"tags" : [ "9", "10", "11", "::)", "bikini", "blue eyes", "character:samus aran", "flower", "wew" ]
}

    Mostly, hydrus simply trims excess whitespace, but the other examples are rare issues you might run into. 'system' is an invalid namespace, tags cannot be prefixed with hyphens, and any tag starting with ':' is secretly dealt with internally as "[no namespace]:[colon-prefixed-subtag]". Again, you probably won't run into these, but if you see a mismatch somewhere and want to figure it out, or just want to sort some numbered tags, you might like to try this.

GET /add_tags/get_tag_services

Ask the client about its tag services.

  • Restricted access: YES. Add Tags permission needed.

  • Required Headers: n/a

  • Arguments: n/a

  • Response description: Some JSON listing the client's 'local tags' and tag repository services by name.

  • Example response:

    • {
	"local_tags" : [ "my tags" ]
	"tag_repositories" : [ "public tag repository", "mlp fanfic tagging server" ]
}

    Note that a user can rename their services. Don't assume the client's local tags service will be "my tags".

POST /add_tags/add_tags

Make changes to the tags that files have.

  • Restricted access: YES. Add Tags permission needed.

  • Required Headers: n/a

  • Arguments (in JSON):

    • hash : (an SHA256 hash for a file in 64 characters of hexadecimal)
    • hashes : (a list of SHA256 hashes)
    • service_names_to_tags : (an Object of service names to lists of tags to be 'added' to the files)
    • service_names_to_actions_to_tags : (an Object of service names to content update actions to lists of tags)
    • add_siblings_and_parents : obsolete, now does nothing

You can use either 'hash' or 'hashes', and you can use either the simple add-only 'service_names_to_tags' or the advanced 'service_names_to_actions_to_tags'.

The service names are as in the /add_tags/get_tag_services call.

The permitted 'actions' are:

    • 0 - Add to a local tag service.
    • 1 - Delete from a local tag service.
    • 2 - Pend to a tag repository.
    • 3 - Rescind a pend from a tag repository.
    • 4 - Petition from a tag repository. (This is special)
    • 5 - Rescind a petition from a tag repository.

When you petition a tag from a repository, a 'reason' for the petition is typically needed. If you send a normal list of tags here, a default reason of "Petitioned from API" will be given. If you want to set your own reason, you can instead give a list of [ tag, reason ] pairs.

Some example requests:

Adding some tags to a file:

{
	"hash" : "df2a7b286d21329fc496e3aa8b8a08b67bb1747ca32749acb3f5d544cbfc0f56",
	"service_names_to_tags" : {
		"my tags" : [ "character:supergirl", "rating:safe" ]
	}
}

Adding more tags to two files:

{
	"hashes" : [ "df2a7b286d21329fc496e3aa8b8a08b67bb1747ca32749acb3f5d544cbfc0f56", "f2b022214e711e9a11e2fcec71bfd524f10f0be40c250737a7861a5ddd3faebf" ],
	"service_names_to_tags" : {
		"my tags" : [ "process this" ],
		"public tag repository" : [ "creator:dandon fuga" ]
	}
}

A complicated transaction with all possible actions:

{
	"hash" : "df2a7b286d21329fc496e3aa8b8a08b67bb1747ca32749acb3f5d544cbfc0f56",
	"service_names_to_actions_to_tags" : {
		"my tags" : {
			"0" : [ "character:supergirl", "rating:safe" ],
			"1" : [ "character:superman" ]
		},
		"public tag repository" : {
			"2" : [ "character:supergirl", "rating:safe" ],
			"3" : [ "filename:image.jpg" ],
			"4" : [ [ "creator:danban faga", "typo" ], [ "character:super_girl", "underscore" ] ]
			"5" : [ "skirt" ]
		}
	}
}

This last example is far more complicated than you will usually see. Pend rescinds and petition rescinds are not common. Petitions are also quite rare, and gathering a good petition reason for each tag is often a pain.

Note that the enumerated status keys in the service_names_to_actions_to_tags structure are strings, not ints (JSON does not support int keys for Objects).

Response description: 200 and no content.

Note also that hydrus tag actions are safely idempotent. You can pend a tag that is already pended and not worry about an error--it will be discarded. The same for other reasonable logical scenarios: deleting a tag that does not exist will silently make no change, pending a tag that is already 'current' will again be passed over. It is fine to just throw 'process this' tags at every file import you add and not have to worry about checking which files you already added it to.

Adding URLs

GET /add_urls/get_url_files

Ask the client about an URL's files.

  • Restricted access: YES. Import URLs permission needed.

  • Required Headers: n/a

  • Arguments:

    • url : (the url you want to ask about)

  • Example request (for URL http://safebooru.org/index.php?page=post&s=view&id=2753608):

    • /add_urls/get_url_files?url=http%3A%2F%2Fsafebooru.org%2Findex.php%3Fpage%3Dpost%26s%3Dview%26id%3D2753608

  • Response description: Some JSON which files are known to be mapped to that URL. Note this needs a database hit, so it may be delayed if the client is otherwise busy. Don't rely on this to always be fast.

  • Example response:

    • {
	"normalised_url" : "https://safebooru.org/index.php?id=2753608&page=post&s=view"
	"url_file_statuses" : [
		{
			"status" : 2
			"hash" : "20e9002824e5e7ffc240b91b6e4a6af552b3143993c1778fd523c30d9fdde02c",
			"note" : "url recognised: Imported at 2015/10/18 10:58:01, which was 3 years 4 months ago (before this check)."
		}
	]
}

    The 'url_file_statuses' is a list of zero-to-n JSON Objects, each representing a file match the client found in its database for the URL. Typically, it will be of length 0 (for as-yet-unvisited URLs or Gallery/Watchable URLs that are not attached to files) or 1, but sometimes multiple files are given the same URL (sometimes by mistaken misattribution, sometimes by design, such as pixiv manga pages). Handling n files per URL is a pain but an unavoidable issue you should account for.

    'status' is the same as for /add_files/add_file:

    • 0 - File not in database, ready for import (you will only see this very rarely--usually in this case you will just get no matches)
    • 2 - File already in database
    • 3 - File previously deleted

    'hash' is the file's SHA256 hash in hexadecimal, and 'note' is some occasional additional human-readable text you may recognise from hydrus's normal import workflow.

GET /add_urls/get_url_info

Ask the client for information about a URL.

  • Restricted access: YES. Import URLs permission needed.

  • Required Headers: n/a

  • Arguments:

    • url : (the url you want to ask about)

  • Example request (for URL https://8ch.net/tv/res/1846574.html):

    • /add_urls/get_url_info?url=https%3A%2F%2F8ch.net%2Ftv%2Fres%2F1846574.html

  • Response description: Some JSON describing what the client thinks of the URL.

  • Example response:

    • {
	"normalised_url" : "https://8ch.net/tv/res/1846574.html",
	"url_type" : 4,
	"url_type_string" : "watchable url",
	"match_name" : "8chan thread",
	"can_parse" : true,
}

    The url types are currently:

    • 0 - Post URL
    • 2 - File URL
    • 3 - Gallery URL
    • 4 - Watchable URL
    • 5 - Unknown URL (i.e. no matching URL Class)

    'Unknown' URLs are treated in the client as direct File URLs. Even though the 'File URL' type is available, most file urls do not have a URL Class, so they will appear as Unknown. Adding them to the client will pass them to the URL Downloader as a raw file for download and import.

POST /add_urls/add_url

Tell the client to 'import' a URL. This triggers the exact same routine as drag-and-dropping a text URL onto the main client window.

  • Restricted access: YES. Import URLs permission needed. Add Tags needed to include tags.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • url : (the url you want to add)
    • destination_page_key : (optional page identifier for the page to receive the url)
    • destination_page_name : (optional page name to receive the url)
    • show_destination_page : (optional, defaulting to false, controls whether the UI will change pages on add)
    • service_names_to_additional_tags : (optional tags to give to any files imported from this url)
    • filterable_tags : (optional tags to be filtered by any tag import options that applies to the URL)
    • service_names_to_tags : (obsolete, legacy synonym for service_names_to_additional_tags)

If you specify a destination_page_name and an appropriate importer page already exists with that name, that page will be used. Otherwise, a new page with that name will be recreated (and used by subsequent calls with that name). Make sure it that page name is unique (e.g. '/b/ threads', not 'watcher') in your client, or it may not be found.

Alternately, destination_page_key defines exactly which page should be used. Bear in mind this page key is only valid to the current session (they are regenerated on client reset or session reload), so you must figure out which one you want using the /manage_pages/get_pages call. If the correct page_key is not found, or the page it corresponds to is of the incorrect type, the standard page selection/creation rules will apply.

show_destination_page defaults to False to reduce flicker when adding many URLs to different pages quickly. If you turn it on, the client will behave like a URL drag and drop and select the final page the URL ends up on.

service_names_to_additional_tags uses the same data structure as for /add_tags/add_tags. You will need 'add tags' permission, or this will 403. These tags work exactly as 'additional' tags work in a tag import options. They are service specific, and always added unless some advanced tag import options checkbox (like 'only add tags to new files') is set.

filterable_tags works like the tags parsed by a hydrus downloader. It is just a list of strings. They have no inherant service and will be sent to a tag import options, if one exists, to decide which tag services get what. This parameter is useful if you are pulling all a URL's tags outside of hydrus and want to have them processed like any other downloader, rather than figuring out service names and namespace filtering on your end. Note that in order for a tag import options to kick in, I think you will have to have a Post URL URL Class hydrus-side set up for the URL so some tag import options (whether that is Class-specific or just the default) can be loaded at import time.

  • Example request bodies:

    • {
	"url" : "https://8ch.net/tv/res/1846574.html",
	"destination_page_name" : "kino zone",
	"service_names_to_additional_tags" : {
		"my tags" : [ "as seen on /tv/" ]
	}
}
    • {
	"url" : "https://safebooru.org/index.php?page=post&s=view&id=3195917"
	"filterable_tags" : [
		"1girl",
		"artist name",
		"creator:azto dio",
		"blonde hair",
		"blue eyes",
		"breasts",
		"character name",
		"commentary",
		"english commentary",
		"formal",
		"full body",
		"glasses",
		"gloves",
		"hair between eyes",
		"high heels",
		"highres",
		"large breasts",
		"long hair",
		"long sleeves",
		"looking at viewer",
		"series:metroid",
		"mole",
		"mole under mouth",
		"patreon username",
		"ponytail",
		"character:samus aran",
		"solo",
		"standing",
		"suit",
		"watermark"
	]
}

  • Response description: Some JSON with info on the URL added.

  • Example response:

    • {
	"human_result_text" : "\"https://8ch.net/tv/res/1846574.html\" URL added successfully.",
	"normalised_url" : "https://8ch.net/tv/res/1846574.html"
}

POST /add_urls/associate_url

Manage which URLs the client considers to be associated with which files.

  • Restricted access: YES. Import URLs permission needed.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • url_to_add : (an url you want to associate with the file(s))
    • urls_to_add : (a list of urls you want to associate with the file(s))
    • url_to_delete : (an url you want to disassociate from the file(s))
    • urls_to_delete : (a list of urls you want to disassociate from the file(s))
    • hash : (an SHA256 hash for a file in 64 characters of hexadecimal)
    • hashes : (a list of SHA256 hashes)

All of these are optional, but you obviously need to have at least one of 'url' arguments and one of the 'hash' arguments. The single/multiple arguments work the same--just use whatever is convenient for you. Unless you really know what you are doing with URL Classes, I strongly recommend you stick to associating URLs with just one single 'hash' at a time. Multiple hashes pointing to the same URL is unusual and frequently unhelpful.

  • Example request body:

    • {
	"url_to_add" : "https://rule34.xxx/index.php?id=2588418&page=post&s=view",
	"hash" : "3b820114f658d768550e4e3d4f1dced3ff8db77443472b5ad93700647ad2d3ba"
}

  • Response description: 200 with no content. Like when adding tags, this is safely idempotent--do not worry about re-adding URLs associations that already exist or accidentally trying to delete ones that don't.

Managing Cookies

This refers to the cookies held in the client's session manager, which are sent with network requests to different domains.

GET /manage_cookies/get_cookies

Get the cookies for a particular domain.

  • Restricted access: YES. Manage Cookies permission needed.

  • Required Headers: n/a

  • Arguments: domain

  • Example request (for gelbooru.com):

    • /manage_cookies/get_cookies?domain=gelbooru.com

Response description: A JSON Object listing all the cookies for that domain in [ name, value, domain, path, expires ] format.

  • Example response:

    • {
	"cookies" : [
		[ "__cfduid", "f1bef65041e54e93110a883360bc7e71", ".gelbooru.com", "/", 1596223327 ],
		[ "pass_hash", "0b0833b797f108e340b315bc5463c324", "gelbooru.com", "/", 1585855361 ],
		[ "user_id", "123456", "gelbooru.com", "/", 1585855361 ]
	]
}

Note that these variables are all strings except 'expires', which is either an integer timestamp or null for session cookies.

This request will also return any cookies for subdomains. The session system in hydrus generally stores cookies according to the second-level domain, so if you request for specific.someoverbooru.net, you will still get the cookies for someoverbooru.net and all its subdomains.

POST /manage_cookies/set_cookies

Set some new cookies for the client. This makes it easier to 'copy' a login from a web browser or similar to hydrus if hydrus's login system can't handle the site yet.

  • Restricted access: YES. Manage Cookies permission needed.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • cookies : (a list of cookie rows in the same format as the GET request above)

  • Example request body:

    • {
	"cookies" : [
		[ "PHPSESSID", "07669eb2a1a6e840e498bb6e0799f3fb", ".somesite.com", "/", 1627327719 ],
		[ "tag_filter", "1", ".somesite.com", "/", 1627327719 ]
	]
}

You can set 'value' to be null, which will clear any existing cookie with the corresponding name, domain, and path (acting essentially as a delete).

Expires can be null, but session cookies will time-out in hydrus after 60 minutes of non-use.

Managing Pages

This refers to the pages of the main client UI.

GET /manage_pages/get_pages

Get the page structure of the current UI session.

  • Restricted access: YES. Manage Pages permission needed.

  • Required Headers: n/a

  • Arguments: n/a

Response description: A JSON Object of the top-level page 'notebook' (page of pages) detailing its basic information and current sub-pages. Page of pages beneath it will list their own sub-page lists.

  • Example response:

    • {
	"pages" : {
		"name" : "top pages notebook",
		"page_key" : "3b28d8a59ec61834325eb6275d9df012860a1ecfd9e1246423059bc47fb6d5bd",
		"page_type" : 10,
		"selected" : true,
		"pages" : [
			{
				"name" : "files",
				"page_key" : "d436ff5109215199913705eb9a7669d8a6b67c52e41c3b42904db083255ca84d",
				"page_type" : 6,
				"selected" : false
			},
			{
				"name" : "thread watcher",
				"page_key" : "40887fa327edca01e1d69b533dddba4681b2c43e0b4ebee0576177852e8c32e7",
				"page_type" : 9,
				"selected" : false
			},
			{
				"name" : "pages",
				"page_key" : "2ee7fa4058e1e23f2bd9e915cdf9347ae90902a8622d6559ba019a83a785c4dc",
				"page_type" : 10,
				"selected" : true,
				"pages" : [
					{
						"name" : "urls",
						"page_key" : "9fe22cb760d9ee6de32575ed9f27b76b4c215179cf843d3f9044efeeca98411f",
						"page_type" : 7,
						"selected" : true
					},
					{
						"name" : "files",
						"page_key" : "2977d57fc9c588be783727bcd54225d577b44e8aa2f91e365a3eb3c3f580dc4e",
						"page_type" : 6,
						"selected" : false
					}
				]
			}	
		]
	}
}

The page types are as follows:

    • 1 - Gallery downloader
    • 2 - Simple downloader
    • 3 - Hard drive import
    • 5 - Petitions (used by repository janitors)
    • 6 - File search
    • 7 - URL downloader
    • 8 - Duplicates
    • 9 - Thread watcher
    • 10 - Page of pages

The top page of pages will always be there, and always selected. 'selected' means which page is currently in view and will propagate down other page of pages until it terminates. It may terminate in an empty page of pages, so do not assume it will end on a 'media' page.

The 'page_key' is a unique identifier for the page. It will stay the same for a particular page throughout the session, but new ones are generated on a client restart or other session reload.

GET /manage_pages/get_page_info

Get information about a specific page.

This is under construction. The current call dumps a ton of info for different downloader pages. Please experiment in IRL situations and give feedback for now! I will flesh out this help with more enumeration info and examples as this gets nailed down. POST commands to alter pages (adding, removing, highlighting), will come later.

  • Restricted access: YES. Manage Pages permission needed.

  • Required Headers: n/a

  • Arguments:

    • page_key : (hexadecimal page_key as stated in /manage_pages/get_pages)
    • simple : true or false (optional, defaulting to true)

  • Example request:

    • /manage_pages/get_page_info?page_key=aebbf4b594e6986bddf1eeb0b5846a1e6bc4e07088e517aff166f1aeb1c3c9da&simple=true

Response description: A JSON Object of the page's information. At present, this mostly means downloader information.

  • Example response with simple = true:

    • {
	"page_info" : {
		"name" : "threads",
		"page_key" : "aebbf4b594e6986bddf1eeb0b5846a1e6bc4e07088e517aff166f1aeb1c3c9da",
		"page_type" : 3,
		"management" : {
			"multiple_watcher_import" : {
				"watcher_imports" : [
					{
						"url" : "https://someimageboard.net/m/123456",
						"watcher_key" = "cf8c3525c57a46b0e5c2625812964364a2e801f8c49841c216b8f8d7a4d06d85",
						"created" = 1566164269,
						"last_check_time" = 1566164272,
						"next_check_time" = 1566174272,
						"files_paused" = false,
						"checking_paused" = false,
						"checking_status" = 0,
						"subject" = "gundam pictures",
						"imports" : {
							"status" : "4 successful (2 already in db)",
							"simple_status" : "4",
							"total_processed" : 4,
							"total_to_process" : 4
						},
						"gallery_log" : {
							"status" = "1 successful",
							"simple_status" = "1",
							"total_processed" = 1,
							"total_to_process" = 1
						}
					},
					{
						"url" : "https://someimageboard.net/a/1234",
						"watcher_key" = "6bc17555b76da5bde2dcceedc382cf7d23281aee6477c41b643cd144ec168510",
						"created" = 1566063125,
						"last_check_time" = 1566063133,
						"next_check_time" = 1566104272,
						"files_paused" = false,
						"checking_paused" = true,
						"checking_status" = 1,
						"subject" = "anime pictures",
						"imports" : {
							"status" : "124 successful (22 already in db), 2 previously deleted",
							"simple_status" : "124",
							"total_processed" : 124,
							"total_to_process" : 124
						},
						"gallery_log" : {
							"status" = "3 successful",
							"simple_status" = "3",
							"total_processed" = 3,
							"total_to_process" = 3
						}
					}
					]
				},
				"highlight" : "cf8c3525c57a46b0e5c2625812964364a2e801f8c49841c216b8f8d7a4d06d85"
			}
		},
		"media" : {
			"num_files" : 4
		}
	}
}

    As you can see, even the 'simple' mode can get very large. Imagine that response for a page watching 100 threads! Turning simple mode off will display every import item, gallery log entry, and all hashes in the media (thumbnail) panel.

    For this first version, the five importer pages--hdd import, simple downloader, url downloader, gallery page, and watcher page--all give rich info based on their specific variables. The first three only have one importer/gallery log combo, but the latter two of course can have multiple. The "imports" and "gallery_log" entries are all in the same data format.

POST /manage_pages/focus_page

'Show' a page in the main GUI, making it the current page in view. If it is already the current page, no change is made.

  • Restricted access: YES. Manage Pages permission needed.

  • Required Headers:

    • Content-Type : application/json

  • Arguments (in JSON):

    • page_key : (the page key for the page you wish to show)

The page key is the same as fetched in the /manage_pages/get_pages call.

  • Example request body:

    • {
	"page_key" : "af98318b6eece15fef3cf0378385ce759bfe056916f6e12157cd928eb56c1f18"
}

  • Response description: 200 with no content. If the page key is not found, this will 404.

Searching Files

File search in hydrus is not paginated like a booru--all searches return all results in one go. In order to keep this fast, search is split into two steps--fetching file identifiers with a search, and then fetching file metadata in batches. You may have noticed that the client itself performs searches like this--thinking a bit about a search and then bundling results in batches of 256 files before eventually throwing all the thumbnails on screen.

GET /get_files/search_files

Search for the client's files.

  • Restricted access: YES. Search for Files permission needed. Additional search permission limits may apply.

  • Required Headers: n/a

  • Arguments (in percent-encoded JSON):

    • tags : (a list of tags you wish to search for)
    • system_inbox : true or false (optional, defaulting to false)
    • system_archive : true or false (optional, defaulting to false)

  • Example request for all files in the inbox with tags "blue eyes", "blonde hair", and "кино":

    • /get_files/search_files?system_inbox=true&tags=%5B%22blue%20eyes%22%2C%20%22blonde%20hair%22%2C%20%22%5Cu043a%5Cu0438%5Cu043d%5Cu043e%22%5D

If the access key's permissions only permit search for certain tags, at least one whitelisted/non-blacklisted tag must be in the "tags" list or this will 403. Tags can be prepended with a hyphen to make a negated tag (e.g. "-green eyes"), but these will not be eligible for the permissions whitelist check.

Response description: The full list of numerical file ids that match the search.

  • Example response:

    • {
	"file_ids" : [ 125462, 4852415, 123, 591415 ]
}

File ids are internal and specific to an individual client. For a client, a file with hash H always has the same file id N, but two clients will have different ideas about which N goes with which H. They are a bit faster than hashes to retrieve and search with en masse, which is why they are exposed here.

The search will be performed on the 'local files' file domain and 'all known tags' tag domain. At current, they will be sorted in import time order, newest to oldest (if you would like to paginate them before fetching metadata), but sort options will expand in future.

Note that most clients will have an invisible system:limit of 10,000 files on all queries. I expect to add more system predicates to help searching for untagged files, but it is tricky to fetch all files under any circumstance. Large queries may take several seconds to respond.

GET /get_files/file_metadata

Get metadata about files in the client.

  • Restricted access: YES. Search for Files permission needed. Additional search permission limits may apply.

  • Required Headers: n/a

  • Arguments (in percent-encoded JSON):

    • file_ids : (a list of numerical file ids)
    • hashes : (a list of hexadecimal SHA256 hashes)
    • only_return_identifiers : true or false (optional, defaulting to false)
    • detailed_url_information : true or false (optional, defaulting to false)

You need one of file_ids or hashes. If your access key is restricted by tag, you cannot search by hashes, and the file_ids you search for must have been in the most recent search result.

  • Example request for two files with ids 123 and 4567:

    • /get_files/file_metadata?file_ids=%5B123%2C%204567%5D

  • The same, but only wants hashes back:

    • /get_files/file_metadata?file_ids=%5B123%2C%204567%5D&only_return_identifiers=true

  • And one that fetches two hashes, 4c77267f93415de0bc33b7725b8c331a809a924084bee03ab2f5fae1c6019eb2 and 3e7cb9044fe81bda0d7a84b5cb781cba4e255e4871cba6ae8ecd8207850d5b82:

    • /get_files/file_metadata?hashes=%5B%224c77267f93415de0bc33b7725b8c331a809a924084bee03ab2f5fae1c6019eb2%22%2C%20%223e7cb9044fe81bda0d7a84b5cb781cba4e255e4871cba6ae8ecd8207850d5b82%22%5D

This request string can obviously get pretty ridiculously long. It also takes a bit of time to fetch metadata from the database. In its normal searches, the client usually fetches file metadata in batches of 256.

Response description: A list of JSON Objects that store a variety of file metadata.

  • Example response:

    • {
	"metadata" : [
		{
			"file_id" : 123,
			"hash" : "4c77267f93415de0bc33b7725b8c331a809a924084bee03ab2f5fae1c6019eb2",
			"size" : 63405,
			"mime" : "image/jpg",
			"ext" : ".jpg",
			"width" : 640,
			"height" : 480,
			"duration" : null,
			"has_audio" : false,
			"num_frames" : null,
			"num_words" : null,
			"is_inbox" : true,
			"is_local" : true,
			"is_trashed" : false,
			"known_urls" : [],
			"service_names_to_statuses_to_tags" : {}
			"service_names_to_statuses_to_display_tags" : {}
		},
		{
			"file_id" : 4567,
			"hash" : "3e7cb9044fe81bda0d7a84b5cb781cba4e255e4871cba6ae8ecd8207850d5b82",
			"size" : 199713,
			"mime" : "video/webm",
			"ext" : ".webm",
			"width" : 1920,
			"height" : 1080,
			"duration" : 4040,
			"has_audio" : true,
			"num_frames" : 102,
			"num_words" : null,
			"is_inbox" : false,
			"is_local" : true,
			"is_trashed" : false,
			"known_urls" : [
				"https://gelbooru.com/index.php?page=post&s=view&id=4841557",
				"https://img2.gelbooru.com//images/80/c8/80c8646b4a49395fb36c805f316c49a9.jpg",
				"http://origin-orig.deviantart.net/ed31/f/2019/210/7/8/beachqueen_samus_by_dandonfuga-ddcu1xg.jpg"
			],
			"service_names_to_statuses_to_tags" : {
				"my tags" : {
					"0" : [ "favourites" ]
					"2" : [ "process this later" ]
				},
				"my tag repository" : {
					"0" : [ "blonde_hair", "blue_eyes", "looking_at_viewer" ]
					"1" : [ "bodysuit" ]
				}
			},
			"service_names_to_statuses_to_display_tags" : {
				"my tags" : {
					"0" : [ "favourites" ]
					"2" : [ "process this later", "processing" ]
				},
				"my tag repository" : {
					"0" : [ "blonde hair", "blue eyes", "looking at viewer" ]
					"1" : [ "bodysuit", "clothing" ]
				}
			}
		}
	]
}

    And one where only_return_identifiers is true:

    • {
	"metadata" : [
		{
			"file_id" : 123,
			"hash" : "4c77267f93415de0bc33b7725b8c331a809a924084bee03ab2f5fae1c6019eb2"
		},
		{
			"file_id" : 4567,
			"hash" : "3e7cb9044fe81bda0d7a84b5cb781cba4e255e4871cba6ae8ecd8207850d5b82"
		}
	]
}

Size is in bytes. Duration is in milliseconds, and may be an int or a float.

The service_names_to_statuses_to_tags structures are similar to the /add_tags/add_tags scheme, excepting that the status numbers are:

    • 0 - current
    • 1 - pending
    • 2 - deleted
    • 3 - petitioned

Note that since JSON Object keys must be strings, these status numbers are strings, not ints.

While service_names_to_statuses_to_tags represents the actual tags stored on the database for a file, the service_names_to_statuses_to_display_tags structure reflects how tags appear in the UI, after siblings are collapsed and parents are added. If you want to edit a file's tags, use service_names_to_statuses_to_tags. If you want to render to the user, use service_names_to_statuses_to_displayed_tags.

If you add detailed_url_information=true, a new entry, 'detailed_known_urls', will be added for each file, with a list of the same structure as /add_urls/get_url_info. This may be an expensive request if you are querying thousands of files at once.

For example:

    • "detailed_known_urls" : [
	{
		"normalised_url": "https://gelbooru.com/index.php?id=4841557&page=post&s=view",
		"url_type": 0,
		"url_type_string": "post url",
		"match_name": "gelbooru file page",
		"can_parse": True
	},
	{
		"normalised_url": "https://img2.gelbooru.com//images/80/c8/80c8646b4a49395fb36c805f316c49a9.jpg",
		"url_type": 5,
		"url_type_string": "unknown url",
		"match_name": "unknown url",
		"can_parse": False
	}
]

GET /get_files/file

Get a file.

  • Restricted access: YES. Search for Files permission needed. Additional search permission limits may apply.

  • Required Headers: n/a

  • Arguments :

    • file_id : (numerical file id for the file)
    • hash : (a hexadecimal SHA256 hash for the file)

Only use one. As with metadata fetching, you may only use the hash argument if you have access to all files. If you are tag-restricted, you will have to use a file_id in the last search you ran.

  • Example requests:

    • /get_files/file?file_id=452158

    • /get_files/file?hash=7f30c113810985b69014957c93bc25e8eb4cf3355dae36d8b9d011d8b0cf623a

  • Response description: The file itself. You should get the correct mime type as the Content-Type header.

GET /get_files/thumbnail

Get a file's thumbnail.

  • Restricted access: YES. Search for Files permission needed. Additional search permission limits may apply.

  • Required Headers: n/a

  • Arguments :

    • file_id : (numerical file id for the file)
    • hash : (a hexadecimal SHA256 hash for the file)

Only use one. As with metadata fetching, you may only use the hash argument if you have access to all files. If you are tag-restricted, you will have to use a file_id in the last search you ran.

  • Example requests:

    • /get_files/thumbnail?file_id=452158

    • /get_files/thumbnail?hash=7f30c113810985b69014957c93bc25e8eb4cf3355dae36d8b9d011d8b0cf623a

  • Response description: The thumbnail for the file. It will give application/octet-stream as the mime type. Some hydrus thumbs are jpegs, some are pngs.

No Comments
Back to top