Thumbnails

An API Key is required for this service. See Shared Responses for common error responses.

Get Thumbnail Information

GET https://thumbs.yiff.rest/:id

Path Parameters

Name	Type	Description
id*	String	The MD5 or ID of an e621 post.

404: Not Found Invalid Post ID

{
  "success": false,
  "error": "Invalid Post ID",
  "code": 1062
}

404: Not Found Invalid MD5

{
  "success": false,
  "error": "Invalid MD5",
  "code": 1063
}

200: OK Success

{
  "success": true,
  "gifURL": "https://thumbsyiff.media/{md5}.gif", // or null
  "pngURL": "https://thumbs.yiff.media/{md5}.png" // or null
}

Create Thumbnail

PUT https://thumbs.yifff.rest/:id/:type

A 202 Accepted will be returned in most circumstances. This is a non committal answer. You must fetch checkURL at the specified checkAt time. (you will be given a new check time if it's still processing)

If generation has already been started by someone else, a 202 Accepted will still be returned.

If a thumbnail has already been created, a 200 OK will be returned.

If Read Only is enabled, a 503 Service Unavailable will be returned.

Path Parameters

Name	Type	Description
id*	String	The MD5 or ID of an e621 post.
type*	String	png

404: Not Found Invalid Post ID

{
  "success": false,
  "error": "Invalid Post ID",
  "code": 1062
}

404: Not Found Invalid MD5

{
  "success": false,
  "error": "Invalid MD5",
  "code": 1063
}

404: Not Found Invalid Type

{
  "success": false,
  "error": "Invalid Type",
  "code": 1064
}

200: OK Already Created

{
  "success": true,
  "status": "done",
  "url": "https://.yiff.media/{md5}.{type}"
}

202: Accepted Success

{
  "success": true,
  "status": "processing",
  "checkURL": "https://thumbs.yiff.rest/check/{gif}/{type}",
  "checkAt": 0, // (unix millis) the time at which you should fetch the above url
  "time": 0, // the milliseconds after which you should check the above url (see checkAt)
  "startedAt": 0, // (unix millis) the time at which processing started
}

500: Internal Server Error Generation Error

// this will never be returned on initial generation, only
// if you make a request for one that has already started
{
  "success": false,
  "status": "error",
  "code": 1060
}

408: Request Timeout Generation Timeout

// this will never be returned on initial generation, only
// if you make a request for one that has already started
{
  "success": false,
  "status": "timeout",
  "code": 1065
}

503: Service Unavailable Read Only

{
  "success": false,
  "error": "Service is currently in read-only mode.",
  "code": 2
}

Check Generation Progress

GET https://thumbs.yiff.rest/check/:md5/:type

If Read Only is enabled, a 503 Service Unavailable will be returned.

Path Parameters

Name	Type	Description
id*	String	The MD5 of an e621 post. This MUST be an md5, you will be given this if you did not have it.
type*	String	png

404: Not Found Invalid MD5

{
  "success": false,
  "error": "Invalid MD5",
  "code": 1061
}

404: Not Found Invalid Type

{
  "success": false,
  "error": "Invalid Type",
  "code": 1064
}

201: Created Done

{
  "success": true,
  "status": "done",
  "url": "https://thumbs.yiff.media/{md5}.{type}"
}

200: OK Processing

{
  "success": true,
  "status": "processing",
  "checkURL": "https://thumbs.yiff.rest/check/{gif}/{type}",
  "checkAt": 0, // (unix millis) the time at which you should fetch the above url
  "time": 0, // the milliseconds after which you should check the above url (see checkAt)
  "startedAt": 0, // (unix millis) the time at which processing started
}

404: Not Found Not Found

{
  "success": false,
  "error": "Not Found",
  "code": 1066
}

408: Request Timeout Generation Timeout

{
  "success": false,
  "status": "timeout",
  "code": 1065
}

500: Internal Server Error Generation Error

{
  "success": false,
  "status": "error",
  "code": 1060
}

503: Service Unavailable Read Only

{
  "success": false,
  "error": "Service is currently in read-only mode.",
  "code": 2
}