Post Sets

Search Post Sets

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

Query Parameters

Name	Type	Description
search[name]	String	The name of the set.
search[shortname]	String	The shortname of the set.
search[is_public]	Boolean	If the set is public. Moderator+ Required
search[creator_name]	String	The name of the creator of the set.
search[creator_id]	Number	The ID of the creator of the set.
search[order]	String	The order of the returned results. One of: update, updated_at, name, shortname, created_at, postcount, post_count
search[id]	Number	See Search Parameters: search[id]
limit	Number	See Search Parameters: limit
page	String	See Search Parameters: page

200: OK Success (Results)

[
  {
    "created_at": "0000-00-00T00:00:00.000-00:00",
    "creator_id": 0,
    "description": "",
    "id": 0,
    "is_public": false,
    "name": "",
    "post_count": 0,
    "post_ids": [
      0
    ],
    "shortname": "",
    "transfer_on_delete": false,
    "updated_at": "0000-00-00T00:00:00.000-00:00"
  }
]

200: OK Success (No Results) !!

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

Get Post Set

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

Moderator+ Required If set is private.

Path Parameters

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

200: OK Success

{
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "description": "",
  "id": 0,
  "is_public": false,
  "name": "",
  "post_count": 0,
  "post_ids": [
    0
  ],
  "shortname": "",
  "transfer_on_delete": false,
  "updated_at": "0000-00-00T00:00:00.000-00:00"
}

403: Forbidden Access Denied (Private)

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

404: Not Found Not Found

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

Create Post Set

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

Authorization Required

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

Request Body

Name	Type	Description
post_set[name]*	String	The name of the set. Min: 3 / Max: 100
post_set[shortname]*	String	The shortname of the set. Cannot be only digits. Min: 3 / Max: 50
post_set[description]	String	The description of the set. Max: 10,000
post_set[is_public]	Boolean	If the set is public.
post_set[transfer_on_delete]	Boolean	If parents of deleted posts are transferred into the set.

201: Created Success

{
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "description": "",
  "id": 0,
  "is_public": false,
  "name": "",
  "post_count": 0,
  "post_ids": [
    0
  ],
  "shortname": "",
  "transfer_on_delete": false,
  "updated_at": "0000-00-00T00:00:00.000-00:00"
}

403: Forbidden Access Denied

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

422: Unprocessable Entity Account Too New

{
  "errors": {
    "base": [
      "Can't make a set public until your account is at least three days old"
    ]
  }
}

422: Unprocessable Entity Name Taken

{
  "errors": {
    "name": [
      "is already taken"
    ]
  }
}

422: Unprocessable Entity Short Name Taken

{
  "errors": {
    "shortname": [
      "is already taken"
    ]
  }
}

422: Unprocessable Entity Name Too Short/Long

{
  "errors": {
    "name": [
      "must be between three and one hundred characters long"
    ]
  }
}

422: Unprocessable Entity Short Name Too Short/Long

{
  "errors": {
    "shortname": [
      "must be between three and fifty characters long"
    ]
  }
}

422: Unprocessable Entity Short Name Only Digits

{
  "errors": {
    "shortname": [
      "must contain at least one lowercase letter or underscore"
    ]
  }
}

422: Unprocessable Entity Description Too Long

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

422: Unprocessable Entity Hourly Limit Reached

{
  "errors": {
    "base": [
      "You have already created 6 sets in the last hour."
    ]
  }
}

422: Unprocessable Entity Set Limit Reached

{
  "errors": {
    "base": [
      "You can only create 75 sets."
    ]
  }
}

Edit Post Set

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

Authorization Required

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

Admin+ Required If the set is not yours.

Path Parameters

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

Request Body

Name	Type	Description
post_set[name]*	String	The name of the set. Min: 3 / Max: 100
post_set[shortname]*	String	The shortname of the set. Cannot be only digits. Min: 3 / Max: 50
post_set[description]	String	The description of the set. Max: 10,000
post_set[is_public]	Boolean	If the set is public.
post_set[transfer_on_delete]	Boolean	If parents of deleted posts are transferred into the set.

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 Account Too New

{
  "errors": {
    "base": [
      "Can't make a set public until your account is at least three days old"
    ]
  }
}

422: Unprocessable Entity Name Taken

{
  "errors": {
    "name": [
      "is already taken"
    ]
  }
}

422: Unprocessable Entity Short Name Taken

{
  "errors": {
    "shortname": [
      "is already taken"
    ]
  }
}

422: Unprocessable Entity Name Too Short/Long

{
  "errors": {
    "name": [
      "must be between three and one hundred characters long"
    ]
  }
}

422: Unprocessable Entity Short Name Too Short/Long

{
  "errors": {
    "shortname": [
      "must be between three and fifty characters long"
    ]
  }
}

422: Unprocessable Entity Short Name Only Digits

{
  "errors": {
    "shortname": [
      "must contain at least one lowercase letter or underscore"
    ]
  }
}

422: Unprocessable Entity Description Too Long

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

Delete Post Set

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

Authorization Required

Admin+ Required If the set isn't yours.

Path Parameters

Name	Type	Description
id*	Number	The ID of the set 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"
}

Add Posts To Post Set

POST https://e621.net/post_sets/{id}/add_posts.json

Authorization Required

Admin+ Required If the post set isn't owned or maintained by you.

While the limit is 10,000 posts, attempting to add that many posts at once will most likely result in a timeout with status code 524. A request that would take the set over the 10,000 post limit will fail and none of the posts will be added. Invalid IDs are silently ignored. This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the set to add posts to.

Request Body

Name	Type	Description
post_ids[]*	Number	An array of post IDs to add to the set. Limit: 10,000

201: Created Success

{
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "description": "",
  "id": 0,
  "is_public": false,
  "name": "",
  "post_count": 0,
  "post_ids": [
    0
  ],
  "shortname": "",
  "transfer_on_delete": false,
  "updated_at": "0000-00-00T00:00:00.000-00:00"
}

403: Forbidden Access Denied

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

404: Not Found Not Found

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

422: Unprocessable Entity Post Set Too Large

{
  "errors": {
    "base": [
      "Sets can have up to 10,000 posts each"
    ]
  }
}

500: Internal Server Error post_ids[] missing

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

Remove Posts From Post Set

POST https://e621.net/post_sets/{id}/remove_posts.json

Authorization Required

Admin+ Required If the post set isn't owned or maintained by you.

Invalid IDs are silently ignored. This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the set to remove posts from.

Request Body

Name	Type	Description
post_ids[]*	Number	An array of post IDs to remove from the set

201: Created Success

{
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "description": "",
  "id": 0,
  "is_public": false,
  "name": "",
  "post_count": 0,
  "post_ids": [
    0
  ],
  "shortname": "",
  "transfer_on_delete": false,
  "updated_at": "0000-00-00T00:00:00.000-00:00"
}

403: Forbidden Access Denied

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

404: Not Found Not Found

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

500: Internal Server Error post_ids[] missing

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

Post Sets For Select

GET https://e621.net/post_sets/for_select.json

Authorization Required

undefined

Invalid IDs are silently ignored. This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the set to remove posts from.

Request Body

Name	Type	Description
post_ids[]*	Number	An array of post IDs to remove from the set

201: Created Success

{
  "Owned": [
    "", // name
    0 // id
  ],
  "Maintained": [
    "", // name
    0 // id
  ]
}

403: Forbidden Access Denied

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