Miyuu's Image Board

api:posts

Table of Contents

•1. Record field format
•2. Associated attributes
•3. Nomenclature
•4. Actions
•5. See also
•6. External links
[/ul]


The following includes the details of how to interface with the post records through the API.

Record field format

[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
uploader_id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
approver_id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
tag_string
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_string_general
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_string_artist
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_string_copyright
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_string_character
[/td]

[td]string[/td]

[td][/td]

[/tr][tr]

[td]
tag_string_meta
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
rating
[/td]

[td]string or null[/td]

[td]includes [g, s, q, e][/td]

[/tr]

[tr]

[td]
parent_id
[/td]

[td]integer or null[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
source
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
md5
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
file_url
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
large_file_url
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
preview_file_url
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
file_ext
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
file_size
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
image_width
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
score
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
fav_count
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_count_general
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_count_artist
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_count_copyright
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_count_character
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
tag_count_meta
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
last_comment_bumped_at
[/td]

[td]timestamp or null[/td]

[td][/td]

[/tr]

[tr]

[td]
last_noted_at
[/td]

[td]timestamp or null[/td]

[td][/td]

[/tr]

[tr]

[td]
has_children
[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]
image_height
[/td]

[td]integer[/td]

[td][/td]

[/tr]

[tr]

[td]
created_at
[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[tr]

[td]
updated_at
[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Associated attributes

[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Number[/th]

[th]Availability[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

uploader
[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]
updater
[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]
approver
[/td]

[td]user[/td]

[td]single[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
parent
[/td]

[td]post[/td]

[td]single[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
children
[/td]

[td]post[/td]

[td]multiple[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
artist_commentary
[/td]

[td]artist_commentary[/td]

[td]single[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
notes
[/td]

[td]note[/td]

[td]multiple[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
comments
[/td]

[td]comment[/td]

[td]multiple[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
flags
[/td]

[td]post flag[/td]

[td]multiple[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
appeals
[/td]

[td]post appeals[/td]

[td]multiple[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
approvals
[/td]

[td]post approval[/td]

[td]multiple[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
replacements
[/td]

[td]post replacement[/td]

[td]multiple[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]
pixiv_ugoira_frame_data
[/td]

[td]Pixiv ugoira frame data[/td]

[td]single[/td]

[td]optional[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Nomenclature

  • Plural form: "posts"
•• Used in the URL pathname
  • Singular form: "post"
•• Used for write parameters (Help:API Write Requests)

Actions

These are the various actions that can be done with upload records.

Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/posts.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]The default order is ID descending[/td]

[/tr]

[/tbody]

[/table]

Index parameters

  • tags
    - The post query to search for using tags and metatags (Help:Cheatsheet).
•• 
post[tags]
can also be used. 
  • random
    - Selects a random sampling under the post query.
  • format
    - Chooses which format to return. Can be: html, json, xml, atom.
  • md5
    - Search for an MD5 match. Takes priority over all other parameters.

Show

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/posts/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the post ID[/td]

[/tr]

[/tbody]

[/table]

Create

[table]

[tr]

[td]HTTP method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]/posts.json[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/table]

Create parameters

  • Mandatory:
•• 
upload_media_asset_id
  • Optional:
•• 
tag_string

•• 
rating

•• 
parent_id

•• 
source

•• 
artist_commentary_title

•• 
artist_commentary_desc

•• 
translated_commentary_title

•• 
translated_commentary_desc

•• 
is_pending
- only matters for users with unrestricted uploads.

Update

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/posts/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]$id is the post ID[/td]

[/tr]

[/tbody]

[/table]

Update parameters

  • Optional:
•• 
tag_string

•• 
old_tag_string

•• 
parent_id

•• 
old_parent_id

•• 
source

•• 
old_source

•• 
rating

•• 
old_rating

•• 
has_embedded_notes

Revert

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/posts/$id/revert.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Revert parameters

  • Required:
•• version_id - The post version ID to revert to.

See also

[table]

[tbody]

[tr]

[td]Controller[/td]

[td][/td]

[td][/td]

[/tr]

[tr]

[td]Model[/td]

[td][/td]

[/tr]

[tr]

[td]Policy[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Revision 6 by Anonymous at 2025-04-20 22:40:38.294313