Welcome to Zane API’s documentation!

The Zane API is a uh, wacky, image manipulation API.

Warning

The API is currently a W.I.P. and has breaking changes coming out very often. Not ready for production use.

If you are unable to find what you are looking for, use the following page.

API Refrence

The following documentation defines all of the usable routes in the Zane API.

Authorization

Note

To authorize your requests you must supply your token with one of the following methods.

  • A query parameter named token with your token. ?token=your_token
  • An Authorization header containing your token. Authorization: your_token

Image Manipulation

This section outlines all of the routes used for image manipulation.

Magic

GET /api/magic

This returns a gif of the image being increasingly content aware scaled. Any image gets scaled to 256 x 256.

Example Request:

GET /api/magic?url=https://example.com/img.png&magnitude=0.6 HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/gif
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • magnitude (float) – the magnitude of the content aware scaling. Must be between 0.1 and 2. Values outside of that range will be silently clamped into it. (optional, default is 0.6)
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Floor

Warning

This endpoint is very slow. Use with caution.

GET /api/floor

This returns a gif of the image being bent like a bendy floor? You just have to see it for yourself. Any image gets scaled to 256 x 256.

Example Request:

GET /api/floor?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/gif
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Braille

Note

This endpoint returns text. Not an image.

GET /api/braille

This returns the image (scaled into a square) made with dithering braille characters with an effective resolution of 114 x 136 however you can input an image of any size.

Example Request:

GET /api/braille?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: text/html; charset=utf-8
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Deepfry

GET /api/deepfry

Deepfry an image.

Example Request:

GET /api/deepfry?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Dots

GET /api/dots

Recreate the image with overlapping black and white dots.

Example Request:

GET /api/dots?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Jpeg

GET /api/jpeg

Compresses the image and strips it of any quality. Just like a JPEG.

Example Request:

GET /api/jpeg?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Spread

GET /api/spread

Animates spreading out all the pixels in the image giving a cool explosion-esque look.

Example Request:

GET /api/spread?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/gif
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Cube

GET /api/cube

Makes a 3D looking cube out of the image.

Example Request:

GET /api/cube?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Sort

GET /api/sort

Sort the pixels in the image.

Example Request:

GET /api/sort?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Palette

GET /api/palette

Image that takes up to 8 colors from the image and overlays their color and hex code to the side of the image.

Example Request:

GET /api/palette?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Invert

GET /api/invert

Negate the image.

Example Request:

GET /api/invert?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Posterize

GET /api/posterize

Posterize the image.

Example Request:

GET /api/posterize?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Grayscale

GET /api/grayscale

Convert the image to grayscale.

Example Request:

GET /api/grayscale?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Pixelate

GET /api/pixelate

Scale the image down then scale it back up.

Example Request:

GET /api/pixelate?url=https://example.com/img.png&scale=0.3 HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • scale (float) –

    the scale to pixelate the image with. Lower is more pixelated. Silently clamped between 0.1 and 1. (optional, default is 0.3)

  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Swirl

GET /api/swirl

Animate a swirling effect on the image.

Example Request:

GET /api/swirl?url=https://example.com/img.png&angle=280 HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/gif
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • angle (int) – the max swirl angle in degrees. Not clamped. (optional, default is 280)
  • token (string) – your api-key. (optional, see Authorization)
Response Headers:
 

Sobel

GET /api/sobel

Apply a sobel filter to the image.

Example Request:

GET /api/sobel?url=https://example.com/img.png HTTP/2
Authorization: your_token
Host: zane.ip-bash.com
Accept: image/jpeg, image/png, image/gif

Example response:

HTTP 200 OK
Content-Type: image/png
Status Codes:
  • 200 OK – Manipulation was a success.
Query Parameters:
 
  • url (string) – the url of the image you want to manipulate.
  • token (string) – your api-key. (optional, see Authorization)
Response Headers: