Gelbooru¶

Configuration¶

Authentication¶

To mitigate abusive behavior, Gelbooru occasionally requires authentication to access the API and throttle access to the API, see Gelbooru API Documentation.

To obtain the API key and User ID, create an account on Gelbooru and find the API access credentials in account settings.

GELBOORU_API_KEY¶

Optional

API key for Gelbooru.

GELBOORU_USER_ID¶

Optional

User ID for Gelbooru.

Customizing Storage Path & File Name¶

For more information, refer to Customizing Storage Path & File Name.

GELBOORU_FILE_PATH¶

Optional, defaults to Gelbooru

Storage path for downloaded images.

GELBOORU_FILE_NAME¶

Optional, defaults to {id}

File name for downloaded images.

Available Variables¶

Only common used ones are listed.

{
  "id": "ID",
  "created_at": "Creation date",
  "score": 3,
  "width": 900,
  "height": 1800,
  "md5": "MD5",
  "rating": "general",
  "owner": "danbooru",
  "creator_id": "Creator ID",
  "parent_id": 0,
  "title": ""
}