API reference v3.0.11

Download OpenAPI 3.0.0 YAML description file

Servers

default


POST‚Äč/vectorize
Convert raster images to scalable vector graphics
Info: To find the best parameters for your input images, visit the start page, upload your image and manually fine tune the vectorization parameters until the vector result matches your expections. Then at the bottom there is an api documentation button which applies the paramters to this page.

coming soon on request.
coming soon on request.
coming soon on request.

Info: After you have entered your API key parameter you can use this upload form to try vectorization parameters.


Parameters

Name Description
apikey  *
string
( query )

Use your api key here. Contact britnex+vectorizerapisales@gmail.com to request a trial api key
Important: keep your api key secret!

Default value : YOUR_API_KEY_HERE

colors
number
( query )

Number of colors

Default value : 8

input
string
( query )

The type of input image

Available values : clipart, photo, sketch, drawing

Default value : clipart

output
string
( query )

Desired output file format

Available values : svg, dxf, eps, gcode, stl, png

Default value : svg

svgversion
string
( query )

If output parameter is set to svg, this parameter sets the SVG version

Available values : 1.0, 1.1

Default value : 1.0

dxfunit
string
( query )

If output parameter is set to dxf, this parameter sets the unit for the DXF file

Available values : inch, mm

Default value : inch

pngantialiasing
string
( query )

If output parameter is set to png, this parameter sets if the result PNG file is antialiased

Available values : on, off

Default value : off

antialiasing
string
( query )

Set to 'default' to remove blurry anti-aliasing edges from input image

Available values : off, min, low, default, high, max

Default value : off

roundness
string
( query )

This parameter defines how smooth the corners are calculated

Available values : none, min, low, default, high, max

Default value : default

sort
string
( query )

Sort color layers

Available values : color, color-asc, area, area-desc, blobsize

Default value : color

layers
string
( query )

combine: Each color is vectorized to a seperate layer. Layers are stacked in the the order of the output color circles. upper layers are combined with lower layers to create smooth shapes.
single: Each color is vectorized to a seperate layer.
contour: The contour of shapes is calculated and vectorized to lines instead of shapes
center: The center line of shapes is calculated and vectorized to lines instead of shapes

Available values : combine, single, contour

Default value : combine

minarea
number
( query )

This parameter defines the size of speckles in pixel squared which will be ignored during vectorization

Default value : 5

blur
number
( query )

This parameter defines the smoothing factor around each color shape in percent

Default value : 0

threshold
number
( query )

This parameter defines the factor in percent which is used to automatically merge similar colors in the layers list

Default value : 20

inputfilters
string
( query )

This parameter encodes the input filters in JSON format.

Default value :

outputfilters
string
( query )

This parameter encodes the output filters in JSON format.

Default value :

Request body

Content Type: "application/octet-stream":
Input image binary (for example: PNG or JPEG file format). (no encoding, only the data bytes of the input image) (max. file size 10MB)

Content Type: "multipart/form-data":
Input image binary (for example: PNG or JPEG file format). (standard multipart/form-data encoding with field name 'file') (max. file size 10MB)

Responses

Code Description
200

Output format depends on input parameter

Media type
Controls Accept header.
																								<?xml version="1.0" encoding="UTF-8"?>
<!-- XML example cannot be generated; root element name is undefined -->
																							

Headers:

Name Description Type
X-Credits-Available

Credits available for this apikey

integer
X-Credits-Charged

Credits charged for this api call. (Only successful api calls are charged)

integer
402

Error: Payment required. (apikey not valid for further requests)

Media type
429

Error: Too many requests (default limit: 60 api calls per minute)

Media type
500

Error: Internal Server Error

Media type