Comments

Search Comments

GET https://e621.net/comments.json

No comment information will be returned in this route. See Search Comments (Group By Comment). This is for ui use, so it doesn't serve much api use.

This route does not support the limit parameter. The maximum results will always be 5.

This route does not support search[id].

Query Parameters

Name	Type	Description
group_by	`post`	Where to start the relation of comments from.
tags	String	The tags of the posts.
page	String	See Search Parameters: page

200: OK Success (Results)

{
  "posts": [
    {
      "approver_id": null, // user id
      "change_seq": 0,
      "comment_count": 0,
      "created_at": "0000-00-00T00:00:00.000-00:00",
      "description": "",
      "duration": null,
      "fav_count": 0,
      "file": {
        "ext": "png",
        "height": 4000,
        "md5": "dc3a90deef089384f39e45fdaea96e78",
        "size": 3681606,
        "url": "https://static1.e621.net/data/dc/3a/dc3a90deef089384f39e45fdaea96e78.png",
        "width": 4000
      },
      "flags": {
        "pending": false,
        "flagged": false,
        "note_locked": false,
        "status_locked": false,
        "rating_locked": true,
        "deleted": false
      },
      "has_notes": false,
      "id": 3405794,
      "is_favorited": false,
      "locked_tags": [],
      "pools": [], // numeric pool ids
      "preview": { // width/height may not be correct
        "height": 150,
        "url": "https://static1.e621.net/data/preview/dc/3a/dc3a90deef089384f39e45fdaea96e78.jpg",
        "width": 150
      },
      "rating": "s",
      "relationships": {
        "children": [], // numeric post ids
        "has_active_children": false,
        "has_children": false,
        "parent_id": null // post id
      },
      "sample": {
        "alternates": {},
        "has": false,
        "height": 850,
        "width": 850,
        "url": "https://static1.e621.net/data/sample/dc/3a/dc3a90deef089384f39e45fdaea96e78.jpg"
      },
      "score": {
        "up": 0,
        "down": 0,
        "total": 0
      },
      "sources": "https://twitter.com/broitsCody/status/1532629699083481088",
      "tags": {
        "general": [],
        "species": [],
        "character": [],
        "artist": [],
        "invalid": [],
        "lore": [],
        "meta": []
      },
      "updated_at": "0000-00-00T00:00:00.000-00:00",
      "uploader_id": 0
    }
  ]
}

500: Internal Server Error Success (No Results)

{
  "success": false,
  "message": "An unexpected error occurred.",
  "code": "00000000-0000-0000-0000-000000000000"
}

Search Comments (Group By Comment)

GET https://e621.net/comments.json?group_by=comment

Query Parameters

Name	Type	Description
group_by*	String	comment
search[body_matches]	String	The body of the comment.
search[do_not_bump_post]	Boolean	If the post did not bump. The UI for searching inverts this option.
search[post_tags_match]	String	The tags of the post the comments are on.
search[creator_name]	String	The name of the creator of the comment.
search[creator_id]	Number	The ID of the creator of the comment.
search[is_hidden]	Boolean	If the comment is hidden.
search[is_sticky]	Boolean	If the comment is sticky (post as moderator).
search[post_id]	Number	The ID of the post the comment was made on. Multiple post ids can be separated by commas.
search[poster_id]	Number	The ID of the user that created the post the comment is on.
search[ip_addr]	String	The IP Address of the creator of the comment. See Search Parameters: search[ip_addr].
search[order]	String	The order of the returned results. One of: post_id, post_id_desc, score, score_desc, updated_at, updated_at_desc
search[id]	Number	See Search Parameters: search[id]
limit	Number	See Search Parameters: limit
page	String	See Search Parameters: page

200: OK Success (Results)

[
  {
    "body": "",
    "created_at": "0000-00-00T00:00:00.000-00:00",
    "creator_id": 0,
    "creator_name": "",
    "do_not_bump_post": false,
    "id": 0,
    "is_hidden": false,
    "is_sticky": false,
    "post_id": 0,
    "score": 0,
    "updated_at": "0000-00-00T00:00:00.000-00:00",
    "updater_id": 0,
    "updater_name": "",
    "warning_type": null, // warning, record, ban
    "warning_user_id": null
  }
]

200: OK Success (No Results) !!

// See https://github.com/e621ng/e621ng/issues/359
{
  "comments": []
}

Get Comment

GET https://e621.net/comments/{id}.json

Moderator+ Required If comment is hidden.

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment.

200: OK Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "creator_name": "",
  "do_not_bump_post": false,
  "id": 0,
  "is_hidden": false,
  "is_sticky": false,
  "post_id": 0,
  "score": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0,
  "updater_name": "",
  "warning_type": null, // warning, record, ban
  "warning_user_id": null
}

403: Forbidden Access Denied (Hidden)

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Add Warning To Comment

POST https://e621.net/comments/{id}/warning.json

Authorization Required

Moderator+ Required

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment to add a warning to.

Request Body

Name	Type	Description
record_type*	String	The type of warning to add to the comment. One of: warning, record, ban, unmark.

200: OK Success

{
  "html": "", // new comment html contents
  "posts": {}
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

500: Internal Server Error Invalid Warning Type

{
  "success": false,
  "message": "'TYPE' is not a valid warning_type",
  "code": "00000000-0000-0000-0000-000000000000"
}

Hide Comment

POST https://e621.net/comments/{id}/hide.json

Authorization Required

Moderator+ Required If the comment is not yours.

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment to hide.

201: Created Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "creator_name": "",
  "do_not_bump_post": false,
  "id": 0,
  "is_hidden": false,
  "is_sticky": false,
  "post_id": 0,
  "score": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0,
  "updater_name": "",
  "warning_type": null, // warning, record, ban
  "warning_user_id": null
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Unhide Comment

POST https://e621.net/comments/{id}/unhide.json

Authorization Required

Moderator+ Required

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment to unhide.

201: Created Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "creator_name": "",
  "do_not_bump_post": false,
  "id": 0,
  "is_hidden": false,
  "is_sticky": false,
  "post_id": 0,
  "score": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0,
  "updater_name": "",
  "warning_type": null, // warning, record, ban
  "warning_user_id": null
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Create Comment

POST https://e621.net/comments.json

Authorization Required

Privileged+ Required If account is less than one week old.

Moderator+ Required If comment section is locked.

Request Body

Name	Type	Description
comment[body]*	String	The body of the comment. Min: 1 / Max: 10,000
comment[post_id]*	Number	The ID of the post to comment on.
comment[is_sticky]	Boolean	If the comment is sticky (post as moderator). Moderator+ Required
comment[is_hidden]	Boolean	If the comment is hidden. Moderator+ Required
comment[do_not_bump_post]	Boolean	If the post should not be bumped.

201: Created Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "creator_name": "",
  "do_not_bump_post": false,
  "id": 0,
  "is_hidden": false,
  "is_sticky": false,
  "post_id": 0,
  "score": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0,
  "updater_name": "",
  "warning_type": null, // warning, record, ban
  "warning_user_id": null
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

422: Unprocessable Entity Empty Body

{
  "errors": {
    "body": [
      "has no content"
    ]
  }
}

422: Unprocessable Entity Body Too Short

{
  "errors": {
    "body": [
      "is too short (minimum is 1 character)"
    ]
  }
}

422: Unprocessable Entity Body Too Long

{
  "errors": {
    "body": [
      "is too long (maximum is 10000 characters)"
    ]
  }
}

422: Unprocessable Entity Account Too New

{
  "errors": {
    "base": [
      "User can not yet perform this action. Account is too new."
    ]
  }
}

422: Unprocessable Entity Missing or Invalid post_id

{
  "errors": {
    "post": [
      "must exist"
    ]
  }
}

422: Unprocessable Entity Comments Locked

{
  "errors": {
    "base": [
      "Post has comments locked"
    ]
  }
}

Edit Comment

PATCH https://e621.net/comments/{id}.json

Authorization Required

Moderator+ Required If comment section is locked.

Admin+ Required If the comment is not yours.

Edits performed within 5 minutes of creation will not show the "edited" text.

If the comment is not yours, the edit text will show "updated by NAME". This ignores the normal time window.

Moderator+ Required if comment is marked (shows warn, record, or ban message).

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment to edit.

Request Body

Name	Type	Description
comment[body]*	String	The body of the comment. Min: 1 / Max: 10,000
comment[is_sticky]	Boolean	If the comment is sticky (post as moderator). Moderator+ Required if own comment Admin+ Required otherwise
comment[is_hidden]	Boolean	If the comment is hidden. Moderator+ Required if own comment Admin+ Required otherwise

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

422: Unprocessable Entity Empty Body

{
  "errors": {
    "body": [
      "has no content"
    ]
  }
}

422: Unprocessable Entity Body Too Short

{
  "errors": {
    "body": [
      "is too short (minimum is 1 character)"
    ]
  }
}

422: Unprocessable Entity Body Too Long

{
  "errors": {
    "body": [
      "is too long (maximum is 10000 characters)"
    ]
  }
}

422: Unprocessable Entity Comments Locked

{
  "errors": {
    "base": [
      "Post has comments locked"
    ]
  }
}

Delete Comment

DELETE https://e621.net/comments/{id}.json

Authorization Required

Admin+ Required

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment to delete.

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Vote On Comment

POST https://e621.net/comments/{id}/votes.json

Authorization Required

Privileged+ Required If account is less than 3 days old.

New votes cannot be cast if the comments section is locked. To remove an existing vote, send a request with the current vote. (e.g. -1 = send -1, they will cancel out). You can also use the DELETE method.

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment to vote on.

Request Body

Name	Type	Description
score*	Number	The vote to cast. One of: -1, 1.
no_unvote	Boolean	If the vote should not be removed if it already exists.

200: OK Success

{
  "score": 1,
  "our_score": 1 // our current vote: -1, 0, 1
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

422: Unprocessable Entity Account Too New

{
  "success": false,
  "message": "Validation failed: User can not yet perform this action. Account is too new",
  "code": null
}

422: Unprocessable Entity Own Comment

{
  "success": false,
  "message": "Validation failed: You cannot vote on your own comments",
  "code": null
}

422: Unprocessable Entity Sticky Comment

{
  "success": false,
  "message": "Validation failed: You cannot vote on sticky comments",
  "code": null
}

422: Unprocessable Entity Invalid Vote

{
  "success": false,
  "message": "Invalid vote",
  "code": null
}

422: Unprocessable Entity Locked Vote

{
  "success": false,
  "message": "Vote is locked",
  "code": null
}

422: Unprocessable Entity Comment Section Locked

{
  "success": false,
  "message": "Comment section is locked",
  "code": null
}

Remove Comment Vote

DELETE https://e621.net/comments/{id}/votes.json

Authorization Required

The only vote removed will be the currently authenticated user's vote.

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the comment to remove the vote from.

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

422: Unprocessable Entity Locked Vote

{
  "success": false,
  "message": "You can't remove locked votes",
  "code": null
}