Pixiv Bot

https://pixiv-bot.pages.dev
Admin
A Telegram bot that helps you send artwork from Pixiv on Telegram, supporting message and inline...
Tokens:15,894
Snippets:49
Trust Score:7.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Default Message Template Example

Source: https://pixiv-bot.pages.dev/s

An example of a default message template used by the Pixiv bot, demonstrating the use of variables and hashtags.

```text
#NSFW #AI [XX:Me](https://www.pixiv.net/artworks/67953985) / [rumikuu](https://www.pixiv.net/users/3654183)  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ  
description line1  
description line2
```

--------------------------------

### Pixiv Bot Variables for Formatting

Source: https://pixiv-bot.pages.dev/zh-hans/s

List of available variables that can be used in message formatting, along with their descriptions and usage examples.

```APIDOC
Available Variables for Formatting:
  - Use `%%` as variable delimiters. Text can be added before or after variables.
  - Example: `%链接:|url|?233%` becomes `链接: https://www.pixiv.net/artworks/123?233`
  - To display `|`, escape it with `\`: `%链接:||url||?233%` becomes `链接:| https://www.pixiv.net/artworks/123|?233`
  - Variables:
    - `%title%`: Artwork title
    - `%description%`: Artwork description
    - `%id%`: Artwork ID
    - `%url%`: Artwork URL (e.g., https://www.pixiv.net/artworks/:id)
    - `%tags%`: Artwork tags
    - `%AI%`: Indicates if the artwork is AI-generated
    - `%NSFW%`: Indicates if the artwork is NSFW
    - `%author_id%`: Author ID
    - `%author_url%`: Author URL
    - `%author_name%`: Author name
    - `%p%`: Current page/total pages for multi-page posts (e.g., 1/2)
    - `%mid%`: Special variable for +sc mode
```

--------------------------------

### Telegraph Conversion (`+graph`, `+telegraph`)

Source: https://pixiv-bot.pages.dev/index

This section describes the `+graph` or `+telegraph` command, which converts multiple artworks into a Telegraph page for a quick preview on mobile devices. It includes details on customizing the title, author name, and author link within the Telegraph page, and provides an example of the command usage with custom parameters.

```APIDOC
Input `+graph` / `+telegraph` in the message, and the bot will compile multiple artworks into a Telegraph page.  
It will return a Telegraph link for quick preview on mobile.

> This is part of the Telegram Instant View service, and there may be scraping failures. It is recommended to keep the number of images below 200.
> This part uses a webp conversion server. Directly visiting the telegra.ph page may collect your IP. For more details, please refer to our privacy policy.

Customizing title, author name, and author link in the `telegraph` link:
For example:
```
https://www.pixiv.net/artworks/91105889 +telegraph
title=White Swimsuit
author_name=syokuyou-mogura
author_url=https://www.pixiv.net/users/579672
```

The content after the `=` will be matched, separated by line breaks.
```

--------------------------------

### Telegram MarkdownV2 Escaping

Source: https://pixiv-bot.pages.dev/zh-hans/s

Explanation of characters that need to be escaped in Telegram's MarkdownV2 for proper display, with examples.

```APIDOC
Telegram MarkdownV2 Escaping:
  - Strict validation mode requires escaping specific characters with a backslash `\`.
  - Characters to escape: `_ * [ ] ( ) ~ ` > # + - = | { } . !`
  - Example of escaped text:
    \_ \* \[ \] \( \) \~ \` \> \# \+ \- \= \| \{ \} \. \!
  - Supported Markdown in Telegram: `** __ []() ```
```

--------------------------------

### Telegram MarkdownV2 Escaping Rules

Source: https://pixiv-bot.pages.dev/s

Explains which characters need to be escaped in Telegram's MarkdownV2 to display correctly. It provides examples of both the original and escaped characters.

```APIDOC
Telegram MarkdownV2 Escaping:

Characters that must be escaped: `_ * [ ] ( ) ~ ` > # + - = | { } . !`

Example:
Original: `_ * [ ] ( ) ~ ` > # + - = | { } . !`
Escaped: `\_ \* \[ \] \( \) \~ \` \> \# \+ \- \= \| \{ \} \. \!`
```

--------------------------------

### Pixiv Bot Configuration Commands

Source: https://pixiv-bot.pages.dev/index

Demonstrates how to use commands to configure the Pixiv Bot, including saving persistent settings and managing group settings.

```APIDOC
Persist Configuration:
  `/s +tags -share`
    - Saves `+tags` and `-share` as default configurations.

  Group Settings:
  `/s +overwrite`
    - Enables group members to use group configurations instead of personal ones.

  Single Use Override:
  `+god`
    - Use personal format in a group for a single occasion.
```

--------------------------------

### Pixiv Bot Configuration

Source: https://pixiv-bot.pages.dev/zh-hans/s

Instructions for configuring the Pixiv Bot, including agreeing to the privacy policy and using the `/s` command to open the configuration page.

```APIDOC
Bot Configuration:
  - Access via `/s` command.
  - Requires agreement to privacy policy before configuration.
```

--------------------------------

### Pixiv Bot Command Options

Source: https://pixiv-bot.pages.dev/zh-hant

This section lists various command-line options for the Pixiv Bot, controlling how content is displayed and processed. Options include toggling tags, descriptions, IDs, image-only display, button visibility, caption visibility, and more.

```bash
-+tag | tags | Display work tags.
-+desc | description | Display work description.
-id | show_id | Display work ID.
-+rm | | Display only the image, without buttons or caption.
-kb | keyboard | Whether to display buttons.
-+rm_caption | remove_caption | Whether to display the caption.
-+open | | Whether to display the open button.
-+share | | Whether to display the share button.
-+sc | single_caption | Send only one caption when sending multiple images.
-+above | caption_above | Display the caption above the image.
-+reverse | | Send works in reverse order.
-+file | asfile | Send as a file.
-+af | append_file | Send additional images after sending the work.
-+graph | telegraph | Parse into Telegraph.
-+album | | Whether to send the work as a MediaGroup.
-+one | album_one | Whether to send all works as a single MediaGroup.
-+equal | album_equal | Attempt to send MediaGroup works with balanced distribution.
-+sp | spoiler | Mark the image as hidden (sensitive) content.
-+caption | caption_extraction | Parse image captions and send associated works.
-+overwrite | | Overwrite user custom settings in groups or channels.
+god | | Use your own format in groups or channels where `+overwrite` is used.
```

--------------------------------

### Saving Changes and Debug Info

Source: https://pixiv-bot.pages.dev/zh-hans/s

Information on how to save configuration changes and details about the last update.

```APIDOC
Saving Changes & Debug Info:
  - To save changes anonymously and statically, copy the command and send it to the Pixiv_bot.
  - If the button does not redirect to Telegram or send a message, manually copy the provided text.
  - Debug Info:
    - Last Update: 2025/5/11 01:46:54
```

--------------------------------

### Convert to Telegraph Page

Source: https://pixiv-bot.pages.dev/zh-hant

Explains how to use the `+graph` or `+telegraph` commands to convert Pixiv works into a Telegraph page, providing a link for quick mobile previews. It mentions potential issues with Telegram Instant View and recommends limiting uploads to under 200 images. It also notes the use of a webp conversion server and privacy implications.

```bash
`+graph` `+telegraph` Convert Works to Telegraph Page:
By entering `+graph` or `+telegraph` in the message, the bot will integrate multiple works into a single Telegraph page. It will then return a Telegraph link, allowing for quick previews on mobile.

> This part is a Telegram Instant View service, and there may be cases of scraping failure. It is recommended to upload less than 200 images at a time.
> This part uses a webp conversion server. Directly accessing the telegra.ph page may collect your IP. For more details, please refer to our privacy policy.
```

--------------------------------

### Pixiv Bot Supported Links

Source: https://pixiv-bot.pages.dev/index

Lists the various Pixiv artwork URL formats that the Pixiv Bot can detect and process in message mode.

```APIDOC
Pixiv Artwork Links:
  - pixiv.net/artworks/:id
  - pixiv.net/artworks/en/:id
  - pixiv.net/i/:id
  - pixiv.net/member_illust.php?illust_id=:id
  - pixiv.net/member_illust.php?illust_id=:id#manga
  - :id (pure numbers)
```

--------------------------------

### Pixiv Bot Advanced Configuration: Persistent Settings

Source: https://pixiv-bot.pages.dev/zh-hans

Explains how to use the `/s` command to persistently save configuration options like `+tags` or `-share`. This allows the bot to use these settings by default for future messages. The functionality also extends to group chats.

```APIDOC
Persistent Configuration with `/s`:
Save settings for default behavior.
Example: `/s +tags -share`

This command saves the specified options, and the bot will apply them to subsequent messages.
Applicable in group chats as well.
```

--------------------------------

### Pixiv Bot Commands

Source: https://pixiv-bot.pages.dev/index

This section details various commands for controlling the Pixiv Bot's behavior when displaying artwork. These commands allow users to customize the output by showing or hiding specific information like tags, descriptions, IDs, images, captions, and buttons, or by altering the display order and format.

```APIDOC
Command | Alias | Description | Remark
---|---|---|---
`+tag` | `tags` | Show artwork tags | Artwork tags may not be recognized as clickable links if they contain special characters (e.g., 《》() - ・)
`+desc` | `description` | Show artwork description | 
`+id` | `show_id` | Show artwork ID | Default display format does not include %id% field, please implement through custom message format
`+rm` |  | Show only images | Do not show buttons and caption
`+kb` | `keyboard` | Show or remove buttons | 
`+cp` | `remove_caption` | Show or remove captions | 
`+open` |  | Show or remove open button | 
`+share` |  | Show or remove share button | Forced on in inline mode that switched to mesaage mode. Forced off in channel.
`+sc` | `single_caption` | Show only one caption when sending multiple images | Cannot be used in inline mode
`+above` | `caption_above` | Show caption above the image | 
`+reverse` |  | Send artworks in reverse order | Does not change the order of pages within a artwork
`+file` | `asfile` | Send as file | Cannot be used in inline mode
`+af` | `append_file` | Send images in addition to the artwork | Cannot be used in inline mode
`+graph` | `telegraph` | Convert to Telegraph | Cannot be used in inline mode
`+album` |  | Send artworks as MediaGroup | Cannot be used in inline mode
`+one` | `album_one` | Send all artworks as one MediaGroup | For example, if you send 2 artworks, the bot will send them as one MediaGroup instead of separately
`+equal` | `album_equal` | Try to send MediaGroup artworks in balanced parts | For example, if there are 14 images, it will be split into 7+7 instead of 10+4
`+sp` | `spoiler` | Mark images as hidden (sensitive content) | Cannot be used in inline mode
`+caption` | `caption_extraction` | Extract and send related artworks from image captions | Special requirement, not needed by default
`+overwrite` |  | Override user settings in groups or channels | Cannot be used in inline mode. Using inline mode in groups will not trigger overwrite behavior
`+god` |  | Use own format in groups/channels with `+overwrite` | Cannot be used in inline mode. Cannot persist with `/s +god`
```

--------------------------------

### Pixiv Bot Message Formatting Variables

Source: https://pixiv-bot.pages.dev/s

Lists and describes the variables available for customizing bot messages, including artwork title, description, tags, author information, and more. It also explains how to use variables with separators.

```APIDOC
Pixiv Bot Message Variables:

Variable | Description
---|---
`%title%` | Artwork Title
`%description%` | Artwork Description
`%id%` | Artwork ID
`%url%` | Artwork URL (e.g., https://www.pixiv.net/artworks/:id)
`%tags%` | Artwork Tags
`%AI%` | Is AI Artwork? (e.g., #AI)
`%NSFW%` | Is NSFW Artwork? (e.g., #NSFW)
`%author_id%` | Author ID
`%author_url%` | Author URL
`%author_name%` | Author Name
`%p%` | Current page for multi-page works (e.g., 1/2)
`%mid%` | Variable specific to +sc mode

Usage Example with separators:
`%Link:|url|?233%` -> Link: [https://www.pixiv.net/artworks/123?233](https://www.pixiv.net/artworks/123?233)

Escaping literal '|':
`%Link:||url||?233%` -> Link:| [https://www.pixiv.net/artworks/123](https://www.pixiv.net/artworks/123)|?233%
```

--------------------------------

### Customizable Message Template Structure

Source: https://pixiv-bot.pages.dev/s

Shows the structure of a customizable message template using variables and separators, including how to format links and add conditional tags.

```text
%\#NSFW |NSFW%%\#AI |AI%[%title%](%url%) / [%author_name%](%author_url%)% |p%% |tags%% >|description%
```

--------------------------------

### Pixiv Bot Commands

Source: https://pixiv-bot.pages.dev/zh-hans

This section lists various commands for the Pixiv Bot, controlling how Pixiv content is displayed and processed in Telegram. Commands include options for tags, descriptions, image-only display, caption management, media grouping, and more.

```APIDOC
Pixiv Bot Commands:

- +tag, tags: Display artwork tags. Tags with special characters might not be recognized as clickable links.
- +desc, description: Display artwork description.
- +id, show_id: Display artwork ID. Not included in the default format; requires custom template.
- +rm: Display only the image, without buttons or caption text.
- +kb, keyboard, remove_keyboard: Control the display of buttons.
- +cp, remove_caption: Control the display of caption text.
- +open: Control the display of the open button.
- +share: Control the display of the share button. Forced enabled during inline switching, forced disabled in channels.
- +sc, single_caption: Display only one caption for multiple images. Not usable in inline mode.
- +above, caption_above: Display caption text above the image.
- +reverse: Send artwork in reverse order. Does not change the order of pages within the artwork.
- +file, asfile: Send as a file. Not usable in inline mode.
- +af, append_file: Send additional images after the artwork. Not usable in inline mode.
- +graph, telegraph: Parse into a Telegraph page. Not usable in inline mode.
- +album: Send artwork as a MediaGroup. Not usable in inline mode.
- +one, album_one: Send all artworks as a single MediaGroup. If you send 2 artworks, they will be sent together as one MediaGroup instead of separately.
- +equal, album_equal: Attempt to send MediaGroup artworks with balanced distribution. For example, when sending 14 images, it will be split into 7+7 instead of 10+4.
- +sp, spoiler: Mark images as hidden (sensitive) content. Not usable in inline mode.
- +caption, caption_extraction: Parse image captions and send associated artworks. Special requirement, not needed by default.
- +overwrite: Override user custom settings in groups or channels. Not usable in inline mode. Using inline mode to send images in a group will not trigger the override behavior (the bot cannot know the user's current group).
- +god: Use your own format when using '+overwrite' in groups or channels. Not usable in inline mode. Cannot be persisted using '/s +god'.
```

--------------------------------

### Pixiv Bot Basic Usage

Source: https://pixiv-bot.pages.dev/zh-hans

Explains how the Pixiv Bot responds to Pixiv artwork links in regular chat messages. It lists the supported URL formats and mentions that multiple links in a single message are handled.

```APIDOC
Pixiv Bot Supported Links:
  - pixiv.net/artworks/:id
  - pixiv.net/artworks/en/:id
  - pixiv.net/i/:id
  - pixiv.net/member_illust.php?illust_id=:id
  - pixiv.net/member_illust.php?illust_id=:id#manga
  - :id (numeric only)

Handles multiple links in a single message.
```

--------------------------------

### 自訂範本編輯按鈕

Source: https://pixiv-bot.pages.dev/zh-hant/s

提供了編輯不同類型範本的按鈕，包括一般範本、Inline 範本和媒體群組範本，方便使用者進行自訂。

```HTML
編輯一般範本 編輯 Inline 範本 編輯媒體群組範本
```

--------------------------------

### MediaGroup Series (`+album`)

Source: https://pixiv-bot.pages.dev/index

This section explains the `+album` command, which enables the bot to merge multi-page artworks into Telegram's MediaGroup feature. It details how artworks are grouped, Telegram's limitations on MediaGroup size, and the behavior of related commands like `+one` and `+equal` for managing multiple artworks and balancing image distribution.

```APIDOC
The bot supports merging multi-page artworks into one mediagroup. MediaGroup is a feature in Telegram that allows displaying multiple media in one message.
Thus, the `+album` parameter is enabled by default. If a artwork has multiple pages, all images will be packed into one mediagroup.  
Additionally, Telegram limits a mediagroup to 10 images, so in cases with many images, they will still be sent separately but as mediagroups.  
For cases with more than 20 images, it is recommended to use the `+graph` parameter below to convert the artworks into a Telegram page for instant preview.

`+one`:
If there are multiple artworks, they will all be merged into one mediagroup.

`+equal`:
When the bot sends more than 10 images at a time, it will try to balance the number of images in each mediagroup. For example, if there are 16 images, they will be sent in 2 groups of 8 each.

`+sc`:
Show caption in the mediagroup. This feature allows you to see what is being sent directly, with the format showing only the artwork name and the number of pages. You can still customize this format.
```

--------------------------------

### 訊息格式預設範本

Source: https://pixiv-bot.pages.dev/zh-hant/s

展示了 Pixiv Bot 回傳訊息的預設格式範本，包含標籤、連結、作者資訊和描述等元素，使用者可基於此範本進行自訂。

```text
#NSFW #AI XX:Me | rumikuu #pixiv <https://www.pixiv.net/artworks/67953985>  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ  
description line1  
description line2
```

--------------------------------

### Pixiv Bot Advanced Usage: Persistent Configuration

Source: https://pixiv-bot.pages.dev/zh-hant

Explains how to use the `/s` command to persistently save custom configurations for the Pixiv Bot. This allows users to set default behaviors like including tags or removing buttons for all future messages.

```bash
/s +tags -share
```

--------------------------------

### 儲存變更指令

Source: https://pixiv-bot.pages.dev/zh-hant/s

說明了儲存變更的操作方式，由於匿名和靜態化頁面的考量，使用者需要複製指令並傳送給 Pixiv Bot 來儲存設定。

```HTML
[儲存變更](tg://msg_url?url=)
為了匿名以及靜態化頁面，儲存變更需要您複製指令傳送給 bot。如果上方的按鈕無法跳轉至 Telegram 並傳送訊息給 Pixiv_bot，請手動複製以下文字並貼上給 bot
```

--------------------------------

### Album MediaGroup Series

Source: https://pixiv-bot.pages.dev/zh-hant

Details on the `+album` feature, which groups multiple pages of a work into a single Telegram MediaGroup. It explains the limitations of MediaGroups (max 10 images) and suggests `+graph` for more than 20 images. It also covers specific options within the MediaGroup series.

```bash
`+album` MediaGroup Series:
Bot supports merging multiple pages of a work into a single media group. MediaGroup is a Telegram feature that allows displaying multiple media in one message. Therefore, the `+album` parameter is enabled by default. This parameter's function is to put all images from a single work into one media group if there are differences (pages). Additionally, Telegram limits a media group to a maximum of 10 images, so in cases with many images, they will still be sent separately, but all as media groups.

For more than 20 images, it is recommended to use the `+graph` parameter to convert the work into a Telegram for instant preview.

`+one`: If there are multiple works, all works will be merged into a single media group.
`+equal`: When the bot sends more than 10 images at once, it will attempt to balance the number of images in the mediagroup. For example, if there are 16 images, it will be split into 2 sends of 8 images each.
`+sc`: Display caption in the media group. This feature is for when you need to directly see what has been sent, with the output format being only the work name and page number. You can still customize this format.
```

--------------------------------

### 訊息格式自訂範本範例

Source: https://pixiv-bot.pages.dev/zh-hant/s

提供了多個訊息格式自訂範本的範例，展示了如何組合不同的變數和文字來創建個性化的訊息格式。

```text
#NSFW #AI [XX:Me](https://www.pixiv.net/artworks/67953985) / [rumikuu](https://www.pixiv.net/users/3654183)  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ  
description line1  
description line2
```

```text
#NSFW #AI [XX:Me](https://www.pixiv.net/artworks/67953985) / id=67953985 / [rumikuu](https://www.pixiv.net/users/3654183)  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ  
description line1  
description line2
```

```text
#NSFW #AI XX:Me | rumikuu #pixiv <https://www.pixiv.net/artworks/67953985>  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ
> **description line1  
>  description line2
```

```text
#NSFW #AI [XX:Me](https://www.pixiv.net/artworks/67953985) / [rumikuu](https://www.pixiv.net/users/3654183)  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ
> **description line1  
>  description line2
```

```text
#NSFW #AI [XX:Me](https://www.pixiv.net/artworks/67953985) / id=67953985 / [rumikuu](https://www.pixiv.net/users/3654183)  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ
> **description line1  
>  description line2
```

```text
#NSFW #AI [XX:Me](https://www.pixiv.net/artworks/67953985) / [rumikuu](https://www.pixiv.net/users/3654183)  
#DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ
> description line1  
>  description line2
```

--------------------------------

### Pixiv Bot Inline Mode Usage

Source: https://pixiv-bot.pages.dev/zh-hans

Details the usage of the Pixiv Bot in Telegram's inline mode. It covers how to invoke the bot, mentions username case-insensitivity, and lists scenarios where switching to regular mode is necessary (multi-page works, +spoiler, ugoira).

```APIDOC
Pixiv Bot Inline Mode:
Invoke by typing '@pixiv_bot' in any chat.
Username is case-insensitive.

Scenarios requiring switch to regular mode:
  - Artwork with multiple pages (multi-P)
  - Use of '+spoiler' attribute
  - Animated GIFs (ugoira) not yet transcoded

Search functionality is not yet implemented (requires Pixiv Premium).
```

--------------------------------

### Pixiv Bot Message Formatting

Source: https://pixiv-bot.pages.dev/zh-hans/s

Details on customizing the bot's response message format, including default templates and the use of Telegram's MarkdownV2 engine.

```APIDOC
Message Formatting Configuration:
  - Customize bot's return message format.
  - Be mindful of text length to avoid sending errors.
  - Default Template Example:
    #NSFW #AI XX:Me | rumikuu #pixiv <https://www.pixiv.net/artworks/67953985>
    #DARLINGintheFRANXX #ゼロツー #ココロ #ミク #イクノ #xx:me #トリカゴ
    description line1
    description line2
  - Available actions: Edit Normal Template, Edit Inline Template, Edit Media Group Template.
```

--------------------------------

### Pixiv Bot Custom Message Formatting

Source: https://pixiv-bot.pages.dev/zh-hant

Mentions the capability for custom message formatting but indicates that detailed instructions are available on the configuration page.

```text
TODO (參考配置頁面)
```

--------------------------------

### Pixiv Bot Advanced Configuration: Group Overwrite

Source: https://pixiv-bot.pages.dev/zh-hans

Describes the `+overwrite` setting for group chats, which enforces a unified configuration for all members within the group. It also explains how to temporarily use personal settings within a group using the `+god` flag.

```APIDOC
Group Configuration with `+overwrite`:
Use `/s +overwrite` to enforce group-wide settings for all members.

To use personal settings within a group for a single message, append `+god` to your message.
Note: `+god` does not persist settings.
```

--------------------------------

### Pixiv Bot Custom Message Formatting

Source: https://pixiv-bot.pages.dev/zh-hans

Indicates that custom message formatting is supported, with details available on a separate configuration page. This allows users to tailor the output of the bot.

```APIDOC
Custom Message Formatting:
Users can customize the message format by appending keywords to artwork links (e.g., `+tags`).
Refer to the configuration page for detailed options.
Example: Sending `+tags` with a link will include tags in the output.
```

--------------------------------

### Pixiv Bot Basic Usage

Source: https://pixiv-bot.pages.dev/zh-hant

Explains how the Pixiv Bot responds to Pixiv artwork links in regular chat messages. It supports various URL formats and can handle multiple links in a single message.

```text
pixiv.net/artworks/:id
pixiv.net/artworks/en/:id
pixiv.net/i/:id
pixiv.net/member_illust.php?illust_id=:id
pixiv.net/member_illust.php?illust_id=:id#manga
:id (純數字)
```

--------------------------------

### MediaGroup Series (`+album`)

Source: https://pixiv-bot.pages.dev/zh-hans

The Pixiv Bot supports merging multi-page artworks into a MediaGroup, a Telegram feature that displays multiple media within a single message. The `+album` parameter is enabled by default. If an artwork has multiple pages, all images will be placed in a MediaGroup. Telegram limits MediaGroups to 10 images, so more images will still be sent separately but as MediaGroups. For over 20 images, using the `+graph` parameter to convert artworks for instant preview is recommended.

```APIDOC
MediaGroup Series (`+album`):

- `+album`: By default, this parameter merges multi-page artworks into a single MediaGroup. Telegram limits MediaGroups to 10 images, so more images will be sent in separate MediaGroups.
- `+one`, `album_one`: Merges all artworks into a single MediaGroup if multiple artworks are sent.
- `+equal`, `album_equal`: Attempts to balance the number of images within a MediaGroup when sending more than 10 images. For example, 16 images might be split into two MediaGroups of 8 images each.
- `+sc`, `single_caption`: Displays the caption within a MediaGroup. The output format shows only the artwork name and page count, which can be customized.
```

--------------------------------

### Telegraph Conversion (`+graph`, `+telegraph`)

Source: https://pixiv-bot.pages.dev/zh-hans

Using `+graph` or `+telegraph` in a message will convert multiple artworks into a Telegraph page, returning a Telegraph link for quick preview on mobile devices. This feature utilizes Telegram Instant View and may encounter fetching failures. It's recommended to send fewer than 200 artworks at a time. The conversion process uses a webp conversion server, and visiting the telegra.ph page directly might collect your IP address.

```APIDOC
Telegraph Conversion (`+graph`, `+telegraph`):

- `+graph` / `+telegraph`: Integrates multiple artworks into a Telegraph page and returns a Telegraph link for mobile preview.

Customizing Telegraph Links:

To customize the title, author name, and author URL in the Telegraph link, use the following format:

```
https://www.pixiv.net/artworks/91105889 +telegraph
title=Your Custom Title
author_name=Your Author Name
author_url=https://www.pixiv.net/users/YourUserID
```

- `title`: Sets the title of the Telegraph page.
- `author_name`: Sets the author's name.
- `author_url`: Sets the URL for the author's profile.

Content after the '=' sign will be matched, and lines are separated by newlines.
```

--------------------------------

### Pixiv Bot Advanced Usage: Group Overwrite

Source: https://pixiv-bot.pages.dev/zh-hant

Describes how to use `+overwrite` in group chats to enforce a unified configuration for all members. It also explains the `+god` command for temporarily overriding group settings with personal preferences.

```bash
/s +overwrite

+god
```

--------------------------------

### Telegram MarkdownV2 格式化指南

Source: https://pixiv-bot.pages.dev/zh-hant/s

說明了在 Telegram 中使用 MarkdownV2 格式化訊息時，需要注意的特殊字元以及如何正確跳脫它們，以確保訊息能正常顯示。

```APIDOC
Telegram MarkdownV2 格式化指南:

Telegram 的 MarkdownV2 範本引擎是嚴格驗證模式，您需要使用反斜線 `\` 對以下字元進行跳脫才能正常顯示：
必須跳脫的字元有：`_ * [ ] ( ) ~ ` > # + - = | { } . !`

例如，以下文字：
```
_ * [ ] ( ) ~ ` > # + - = | { } . !
```

應跳脫為：
```
\_ \* \[ \] \( \) \~ \` \> \# \+ \- \= \| \{ \} \. \!
```

這樣，最終在 Telegram 中才能正常顯示。

格式說明:
Telegram 的 Markdown 僅支援以下這些：  
** __ []() ```  
在自訂之前需要注意這些限制  
需要顯示連結？  
`[標題](連結)` 遵循 Markdown 格式即可。  
其他的可以依照預設範本的範例進行修改即可  
  
這裡均使用 `%%` 作為變數，其中變數前後都可以加入想要的文字，使用 `|` 即可加入。
範例: `%連結:|url|?233%` -> 連結: [https://www.pixiv.net/artworks/123?233](https://www.pixiv.net/artworks/123?233)
如果想顯示 `|` 符號，請在前面加上 `\` 來跳脫即可  
`%連結:\||url|\|?233%` -> 連結:| [https://www.pixiv.net/artworks/123](https://www.pixiv.net/artworks/123)|?233  
  
**目前已有的變數有：**
變數 | 說明  
---|---
`%title%` | 作品標題  
`%description%` | 作品描述  
`%id%` | 作品 ID  
`%url%` | 作品連結 [https://www.pixiv.net/artworks/:id](https://www.pixiv.net/artworks/:id)  
`%tags%` | 作品標籤  
`%AI%` | 是否為 AI 生成作品  
`%NSFW%` | 是否為 NSFW 作品  
`%author_id%` | 作者 ID  
`%author_url%` | 作者連結  
`%author_name%` | 作者名稱  
`%p%` | 多頁作品顯示目前頁數，格式為 目前頁數/總頁數，例如 1/2  
`%mid%` | 供 +sc 模式專用變數  
```

--------------------------------

### Pixiv Bot Inline Mode Limitations

Source: https://pixiv-bot.pages.dev/index

Details scenarios where Telegram's inline mode for Pixiv Bot requires switching to normal message mode, such as multi-page artworks or specific commands.

```APIDOC
Inline Mode Switching:
  - Artworks with multiple images (multi-page)
  - Using the `+spoiler` command
  - Ugoira that have not been converted yet
```

--------------------------------

### Customize Telegraph Link Content

Source: https://pixiv-bot.pages.dev/zh-hant

Demonstrates how to customize the title, author name, and author URL within a Telegraph link generated by the Pixiv Bot. It shows the format for specifying these details using key-value pairs separated by newlines.

```bash
Customize Title, Author Name, and Author URL in Telegraph Links:
For example:
```
https://www.pixiv.net/artworks/91105889 +telegraph
title=白スクのやつ
author_name=syokuyou-mogura
author_url=https://www.pixiv.net/users/579672
```

The format is: content after the '=' sign will be matched, separated by newlines.
```

--------------------------------

### Pixiv Bot Inline Mode Usage

Source: https://pixiv-bot.pages.dev/zh-hant

Details the inline mode functionality of the Pixiv Bot, allowing users to share artwork without switching chat contexts. It also outlines scenarios where switching to regular message mode is necessary, such as for multi-page works, spoiler tags, or animated GIFs.

```text
Inline mode usage requires mentioning the bot with `@pixiv_bot`.

Switch to regular message mode for:
- Multi-page artworks (multiple P)
- `+spoiler` attribute
- Animated GIFs (ugoira) not yet converted
```

--------------------------------

### Security and Transparency

Source: https://pixiv-bot.pages.dev/zh-hant/privacy

The Pixiv Bot assures users of its security and transparency. It does not employ user tracking links and does not share usage habits with third parties. The bot's source code is identical to the version available on GitHub, allowing users to self-host if they have concerns about the provided service.

```APIDOC
Security and Transparency:
  - No user tracking links.
  - Usage habits are not shared with third parties.
  - Source code is identical to the GitHub version.
  - Users can self-host to verify.
```

--------------------------------

### Security and Transparency

Source: https://pixiv-bot.pages.dev/zh-hans/privacy

Asserts that the bot does not employ user tracking links and does not share usage habits with third parties. It emphasizes that the running source code is identical to the GitHub version, encouraging users to self-host if they doubt the claims.

```APIDOC
Security:
  - No user tracking links.
  - No sharing of usage habits with third parties.
  - Source code is identical to the GitHub version.
  - Users are encouraged to self-host for verification.
```

--------------------------------

### IP Address Logging

Source: https://pixiv-bot.pages.dev/zh-hant/privacy

Explains when the Pixiv Bot or Cloudflare might obtain a user's IP address. This occurs when accessing Telegraph pages (non-instant preview) for direct image/GIF links provided by Cloudflare or the bot, and when visiting this privacy policy document. Instant previews within Telegram do not involve traffic through this service.

```APIDOC
IP Address Logging:
  When IP may be obtained by Bot/Cloudflare:
    - Accessing Telegraph pages (non-instant preview):
        - Cloudflare provides direct image links.
        - Bot provides direct GIF links.
    - Accessing this document.
  Note: Telegram instant previews do not route traffic through this service.
```

--------------------------------

### Security and Data Practices

Source: https://pixiv-bot.pages.dev/privacy

States that the bot does not use user tracking links or share usage habits with third parties. It emphasizes that the source code is the same as the GitHub version, allowing users to build their own services if they doubt the privacy claims.

```APIDOC
Security and Data Practices:
  - No user tracking links.
  - No sharing of usage habits with third parties.
  - Runs on the same source code as the GitHub version.
```

--------------------------------

### IP Address Collection

Source: https://pixiv-bot.pages.dev/zh-hans/privacy

Explains when the bot or Cloudflare might obtain the user's IP address. This occurs when accessing Telegraph pages (non-instant preview) for direct image/GIF links provided by Cloudflare or the bot, and when accessing the documentation itself.

```APIDOC
IP Address Collection:
  - Accessing Telegraph Pages (non-instant preview):
    - Cloudflare provides direct image links.
    - Bot provides direct GIF links.
    (Note: Instant previews in Telegram do not route traffic through this service.)
  - Accessing Documentation
```

--------------------------------

### IP Address Collection

Source: https://pixiv-bot.pages.dev/privacy

Explains that the bot or Cloudflare may collect IP addresses when accessing telegraph pages (not live preview) or the privacy document itself. Telegram Instant Preview does not transmit traffic through the service.

```APIDOC
IP Address Collection:
  - Accessing telegraph pages (not live preview):
    - Cloudflare provides direct link to original image.
    - Bot provides direct link to moving image.
  - Accessing this document.

Note: Telegram Instant Preview does not pass any traffic through the service.
```

--------------------------------

### Policy Revisions

Source: https://pixiv-bot.pages.dev/zh-hant/privacy

Informs users that the privacy policy may be subject to changes at any time. Continued use of the Pixiv Bot after any modifications implies the user's agreement to the updated terms of the privacy policy.

```APIDOC
Policy Revisions:
  - Privacy policy may be modified at any time.
  - Continued use of the bot signifies agreement to the updated terms.
```

--------------------------------

### Policy Revisions

Source: https://pixiv-bot.pages.dev/privacy

Informs users that the privacy policy may be modified at any time. Continued use of the bot signifies agreement to the updated terms.

```APIDOC
Policy Revisions:
  - The privacy policy may be modified at any time.
  - Continued use of the bot constitutes agreement to the updated terms.
```

--------------------------------

### Policy Revisions

Source: https://pixiv-bot.pages.dev/zh-hans/privacy

Informs users that the privacy policy may be modified at any time. Continued use of the bot implies acceptance of the updated terms.

```APIDOC
Policy Revisions:
  - Privacy policy may be modified at any time.
  - Continued use of the bot constitutes agreement to the policy terms.
```

--------------------------------

### User ID Collection

Source: https://pixiv-bot.pages.dev/privacy

Logs user IDs for specific bot interactions such as customizing reply formats, generating telegraph pages, exporting artist works, and upcoming features like favorites and push notifications. Other operations do not log or associate user information.

```APIDOC
User ID Collection:
  - Customizing reply formats
  - Generating a telegraph page
  - Exporting all of an artist's work
  - Favorites function (coming soon)
  - Pushing the artist's work (coming soon)

Note: User IDs are not logged or associated with user actions in other operations.
```
Tokens:
Raw