API Documentation
API Endpoint
All URIs below are relative to https://api.waifu2x.me/api/
API Key
Your API key: Login
Methods
Methods | |
---|---|
instance/list | GET /api/instance/list Returns a list of instances. |
instance/status | GET /api/instance/status Gets the latest state of instance. |
instance/start | POST /api/instance/start Start the specified instance. |
instance/stop | POST /api/instance/stop Stops the specified instance. |
instance/reset | POST /api/instance/reset Resets the specified instance. |
file/convert | POST /api/file/convert Converts the specified file. |
file/list | GET /api/file/list Returns a list of convert files. |
file/status | GET /api/file/status Gets the latest state of convert file. |
file/delete | POST /api/file/delete Delete the specified file. |
file/bulk-delete | POST /api/file/bulk-delete Delete all conversion files. |
Method: instance/list
HTTP request
GET https://api.waifu2x.me/api/instance/list
Query parameters
Parameters | |
---|---|
apikey |
Required |
CURL Example
curl "https://api.waifu2x.me/api/instance/list?apikey={$apikey}"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/instance/list?apikey={$apikey}",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :get, url: 'https://api.waifu2x.me/api/instance/list?apikey={$apikey}')
puts response
Python Example
import requests
response = requests.get('https://api.waifu2x.me/api/instance/list?apikey={$apikey}')
print(response.json())
Response
JSON representation |
---|
|
Method: instance/status
HTTP request
GET https://api.waifu2x.me/api/instance/status
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
CURL Example
curl "https://api.waifu2x.me/api/instance/status?id={$id}&apikey={$apikey}"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/instance/status?id={$id}&apikey={$apikey}",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :get, url: 'https://api.waifu2x.me/api/instance/status?id={$id}&apikey={$apikey}')
puts response
Python Example
import requests
response = requests.get('https://api.waifu2x.me/api/instance/status?id={$id}&apikey={$apikey}')
print(response.json())
Response
JSON representation |
---|
|
Method: instance/start
HTTP request
POST https://api.waifu2x.me/api/instance/start
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
CURL Example
curl -X POST -F id={$id} -F apikey={$apikey} "https://api.waifu2x.me/api/instance/start"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/instance/start",
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'id' => $id,
'apikey' => $apikey,
],
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :post, url: 'https://api.waifu2x.me/api/instance/start',
payload: {
'id' => id,
'apikey' => apikey,
}
)
puts response
Python Example
import requests
response = requests.post(
'https://api.waifu2x.me/api/instance/start',
data={
'id': id,
'apikey': apikey,
}
)
print(response.json())
Response
JSON representation |
---|
|
Method: instance/reset
HTTP request
POST https://api.waifu2x.me/api/instance/reset
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
CURL Example
curl -X POST -F id={$id} -F apikey={$apikey} "https://api.waifu2x.me/api/instance/reset"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/instance/reset",
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'id' => $id,
'apikey' => $apikey,
],
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :post, url: 'https://api.waifu2x.me/api/instance/reset',
payload: {
'id' => id,
'apikey' => apikey,
}
)
puts response
Python Example
import requests
response = requests.post(
'https://api.waifu2x.me/api/instance/reset',
data={
'id': id,
'apikey': apikey,
}
)
print(response.json())
Response
JSON representation |
---|
|
Method: instance/stop
HTTP request
POST https://api.waifu2x.me/api/instance/stop
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
mail |
Optional
|
CURL Example
curl -X POST -F id={$id} -F apikey={$apikey} "https://api.waifu2x.me/api/instance/stop"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/instance/stop",
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'id' => $id,
'apikey' => $apikey,
],
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :post, url: 'https://api.waifu2x.me/api/instance/stop',
payload: {
'id' => id,
'apikey' => apikey,
}
)
puts response
Python Example
import requests
response = requests.post(
'https://api.waifu2x.me/api/instance/stop',
data={
'id': id,
'apikey': apikey,
}
)
print(response.json())
Response
JSON representation |
---|
|
Method: file/convert
HTTP request
POST https://api.waifu2x.me/api/file/convert
Query parameters
Parameters | |
---|---|
id |
Required |
file |
Required |
style |
Required
|
noise |
Required
|
scale |
Required |
comp |
Required |
apikey |
Required |
wait |
Optional
|
CURL Example
curl -X POST -F id={$id} -F apikey={$apikey} -F style={$style} -F noise={$noise} -F scale={$scale} -F comp={$comp} -F "file=@{$filepath}" "https://api.waifu2x.me/api/file/convert"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/file/convert",
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'id' => $id,
'apikey' => $apikey,
'style' => $style,
'noise' => $noise,
'scale' => $scale,
'comp' => $comp,
'file' => new CURLFile($filepath),
],
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :post, url: 'https://api.waifu2x.me/api/file/convert',
payload: {
'id' => id,
'apikey' => apikey,
'style' => style,
'noise' => noise,
'scale' => scale,
'comp' => comp,
'file' => File.new(filepath),
}
)
puts response
Python Example
import requests
response = requests.post(
'https://api.waifu2x.me/api/file/convert',
data={
'id': id,
'apikey': apikey,
'style': style,
'noise': noise,
'scale': scale,
'comp': comp
},
files={
'file': open(filepath, 'rb')
}
)
print(response.json())
Response
JSON representation |
---|
|
Method: file/list
HTTP request
GET https://api.waifu2x.me/api/file/list
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
CURL Example
curl "https://api.waifu2x.me/api/file/list?id={$id}&apikey={$apikey}"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/file/list?id={$id}&apikey={$apikey}",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :get, url: 'https://api.waifu2x.me/api/file/list?id={$id}&apikey={$apikey}')
puts response
Python Example
import requests
response = requests.get('https://api.waifu2x.me/api/file/list?id={$id}&apikey={$apikey}')
print(response.json())
Response
JSON representation |
---|
|
Method: file/status
HTTP request
GET https://api.waifu2x.me/api/file/status
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
CURL Example
curl "https://api.waifu2x.me/api/file/status?id={$id}&apikey={$apikey}"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/file/status?id={$id}&apikey={$apikey}",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :get, url: 'https://api.waifu2x.me/api/file/status?id={$id}&apikey={$apikey}')
puts response
Python Example
import requests
response = requests.get('https://api.waifu2x.me/api/file/status?id={$id}&apikey={$apikey}')
print(response.json())
Response
JSON representation |
---|
|
Method: file/delete
HTTP request
POST https://api.waifu2x.me/api/file/delete
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
CURL Example
curl -X POST -F id={$id} -F apikey={$apikey} "https://api.waifu2x.me/api/file/delete"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/file/delete",
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'id' => $id,
'apikey' => $apikey,
],
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :post, url: 'https://api.waifu2x.me/api/file/delete',
payload: {
'id' => id,
'apikey' => apikey,
}
)
puts response
Python Example
import requests
response = requests.post(
'https://api.waifu2x.me/api/file/delete',
data={
'id': id,
'apikey': apikey,
}
)
print(response.json())
Response
JSON representation |
---|
|
Method: file/bulk-delete
HTTP request
POST https://api.waifu2x.me/api/file/bulk-delete
Query parameters
Parameters | |
---|---|
id |
Required |
apikey |
Required |
CURL Example
curl -X POST -F id={$id} -F apikey={$apikey} "https://api.waifu2x.me/api/file/bulk-delete"
PHP Example
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://api.waifu2x.me/api/file/bulk-delete",
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'id' => $id,
'apikey' => $apikey,
],
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_RETURNTRANSFER => true,
]);
$result = curl_exec($ch);
$response = json_decode($result, true);
print_r($response);
curl_close($ch);
Ruby Example
require 'rest_client'
response = RestClient::Request.execute(method: :post, url: 'https://api.waifu2x.me/api/file/bulk-delete',
payload: {
'id' => id,
'apikey' => apikey,
}
)
puts response
Python Example
import requests
response = requests.post(
'https://api.waifu2x.me/api/file/bulk-delete',
data={
'id': id,
'apikey': apikey,
}
)
print(response.json())
Response
JSON representation |
---|
|