Version 4.0.14 API Documentation

Using this application programming interface (API) you can integrate our raster image to scalable vector graphics conversion service into your own service or software.

OpenAPI YAML Definition:

vectorizer-io-api-definition-openapi-v4.0.14.yaml

To view documentation or automatically create software client implementations for various programming languages visit and paste the above OpenAPI YAML definition file into the Swagger editor: https://editor.swagger.io/

! Important Information !

No Service-Level Agreement (SLA) is currently offered for this API service. Rest assured, efforts are being made to improve the offerings and introduce SLAs in the future.
Although high availability and error-free performance are strived for, it cannot be guaranteed that the service will always be available and without errors. Understanding and patience are appreciated as the service continues to develop and enhance.
Please note that the service is continually evolving and may undergo changes. Staying informed about updates to the offerings is encouraged.

Client-Side Retry Mechanism

For optimal integration and to ensure a seamless user experience, it's imperative to implement an automatic retry mechanism on the client side when making API calls. Given the potential for transient network issues or server-side errors, this mechanism should include:

Exponential Backoff: Increase the delay between retries exponentially to avoid overwhelming the server.
Random Jitter: Introduce a random delay variation to prevent synchronized retries from multiple clients.
Maximum Retry Limit: Define a maximum number of retry attempts to avoid endless loops.

This approach ensures that temporary issues are gracefully handled, reducing the likelihood of failed operations and enhancing the robustness of your integration.

Pricing

With every monthly subscription payment, your first 100 API calls are included. If you want to do more than 100 api calls per month, please adjust the setting ( Menu / "Api Settings" / "Pay for Additional API Calls" ) to accommodate to pay for extra API calls. Then subsequent invoices will reflect these added charges. Please refer to the table for pricing details:

Number of API calls	Price per API call
1 - 100	Included
101 - 1,000
1,001 - 10,000
10,001 - 100,000
100,001 - 1,000,000
1,000,001+	Contact support for specialized pricing or further discounts

prices rounded to 2 decimal places, incl. VAT if applicable.

Contact

If you have any questions or suggestions on how we can improve our service, please do not hesitate to contact us via email: support+sales@vectorizer.io

API Security:

CreditsCodeAuth ( apiKey )

Successful calls to API endpoints are charged with one credit from the specified credits code. If an error occurs during an API call no credit will be charged.

Add the following HTTP header to authenticate using your credits code:

X-CREDITS-CODE: YOUR_CREDITS_CODE_HERE

API Endpoints:

POST vectorize

POST paintbynumbers

POST vectorize

POST diamondpainting

https://api.vectorizer.io/v4.0/vectorize

Main vectorization endpoint to covert raster images to scalable vector graphics. Upload input image, start vectorization process, keep connection alive until vectorization is completed and download generated output file in specified output file format. Completion time depends on input image size, number of colors and structure but should never exceed 59 seconds.

# cURL HTTP POST using multipart form upload:

 			
<?php

    // this example requires GuzzleHttp Client. for more information visit: https://docs.guzzlephp.org/en/stable/overview.html#installation
    require 'vendor/autoload.php';
    $client = new GuzzleHttp\Client();
    $res = $client->post('https://api.vectorizer.io/v4.0/vectorize', [
	    'multipart' => [
PARAMS
        ],
        'headers' => [
           'X-CREDITS-CODE' => 'YOUR_CREDITS_CODE_HERE',
        ]
    ]);
    $fp = fopen('exampleimage.svg', 'wb');
    fwrite($fp, $res->getBody());
    fclose($fp);

?>

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class VectorizeImage {
    public static void main(String[] args) {
        vectorizeImage();
    }

    public static void vectorizeImage() {
        String url = "https://api.vectorizer.io/v4.0/vectorize";
        String apiKey = "YOUR API CREDITS CODE HERE";
        String imageUrl = "https://yourdomainhere/test/exampleimage.png";
        String outputFormat = "svg";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet imageGetRequest = new HttpGet(imageUrl);
            byte[] imageData;

            try (CloseableHttpResponse imageResponse = httpClient.execute(imageGetRequest)) {
                if (imageResponse.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("Error fetching image: " + imageResponse.getStatusLine());
                }

                HttpEntity imageEntity = imageResponse.getEntity();
                imageData = EntityUtils.toByteArray(imageEntity);
            }

            HttpPost request = new HttpPost(url);
            request.setHeader("X-CREDITS-CODE", apiKey);

            HttpEntity requestEntity = MultipartEntityBuilder.create()
                    .addBinaryBody("image", imageData, ContentType.APPLICATION_OCTET_STREAM, "exampleimage.png")
                    .addTextBody("format", outputFormat)
                    .build();

            request.setEntity(requestEntity);

            try (CloseableHttpResponse response = httpClient.execute(request)) {
                if (response.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("HTTP error! status: " + response.getStatusLine());
                }

                HttpEntity responseEntity = response.getEntity();
                String svg = EntityUtils.toString(responseEntity);
                System.out.println(svg);
            }

        } catch (IOException e) {
            System.err.println("Error while converting image to SVG: " + e.getMessage());
        }
    }
}

import requests
from io import BytesIO

def vectorize_image():
    url = "https://api.vectorizer.io/v4.0/vectorize"
    api_key = "YOUR API CREDITS CODE HERE"
    image_url = "https://yourdomainhere/test/exampleimage.png"
    output_format = "svg"

    try:
        image_response = requests.get(image_url)
        image_response.raise_for_status()
        image_data = BytesIO(image_response.content)

        files = {"image": ("exampleimage.png", image_data, "image/png")}
        data = {"format": output_format}
        headers = {"X-CREDITS-CODE": api_key}

        response = requests.post(url, headers=headers, data=data, files=files)
        response.raise_for_status()

        svg = response.text
        print(svg)

    except requests.exceptions.RequestException as error:
        print("Error while converting image to SVG:", error)

vectorize_image()

async function vectorizeImage() {
  const url = "https://api.vectorizer.io/v4.0/vectorize";
  const apiKey = "YOUR API CREDITS CODE HERE";
  const imagePath = "https://yourdomainhere/test/exampleimage.png";
  const outputFormat = "svg";

  try {
    const imageBlob = await fetch(imagePath).then(response => response.blob());

    const formData = new FormData();
    formData.append("image", imageBlob, "exampleimage.png");
    formData.append("format", outputFormat);

    const response = await fetch(url, {
      method: "POST",
      headers: {
        "X-CREDITS-CODE": apiKey
      },
      body: formData
    });

    if (!response.ok) {
      const text = await response.text();
      console.log( text )
      throw new Error(`HTTP error! status: `);
    }

    const svg = await response.text();
    console.log(svg);

  } catch (error) {
    console.error("Error while converting image to SVG:", error);
  }
}

Try it out:

( no credits available. sign in to enable this button )

Request Body ( multipart/form-data )

Responses

Use the HTTP status code of the response to implement your error handling. The HTTP body of the response is only for debugging purposes and can change without a version change.
For error status codes indicating a server problem (500, 504) it is highly recommended to implement a exponential backoff for retries in your software.

Status Code

Description

200

Output format depends on format argument.

HTTP response headers:

X-CREDITS-AVAILABLE	Number of available credits before starting the vectorization operation. This number does not include the one credit that will be charged for a successful download. [this header requires authentication using X-CREDITS-CODE header]
X-CREDITS-EXPIRE	Credits valid until this date (RFC7231 format). [this header requires authentication using X-CREDITS-CODE header]
X-FREE-CREDITS-AVAILABLE	Free credits available. [this header is only available if not authenticated using X-CREDITS-CODE header]
X-HREF	Direct URL to the image's edit interface.

500

Error: Internal Server Error.

402

Error: Payment required.

413

Error: Payload too large. (max. 10MB)

429

Error: Too many requests (See Menu / API Settings / API Access Limits for configured api limits for your account)

504

Error: Gateway Timeout

https://api.vectorizer.io/v4.0/paintbynumbers

Vectorization endpoint for paint-by-number images. Completion time depends on input image size, number of colors and structure but should never exceed 59 seconds.

# cURL HTTP POST using multipart form upload:

 			
<?php

    // this example requires GuzzleHttp Client. for more information visit: https://docs.guzzlephp.org/en/stable/overview.html#installation
    require 'vendor/autoload.php';
    $client = new GuzzleHttp\Client();
    $res = $client->post('https://api.vectorizer.io/v4.0/paintbynumbers', [
	    'multipart' => [
PARAMS
        ],
        'headers' => [
           'X-CREDITS-CODE' => 'YOUR_CREDITS_CODE_HERE',
        ]
    ]);
    $fp = fopen('exampleimage.svg', 'wb');
    fwrite($fp, $res->getBody());
    fclose($fp);

?>

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class VectorizeImage {
    public static void main(String[] args) {
        vectorizeImage();
    }

    public static void vectorizeImage() {
        String url = "https://api.vectorizer.io/v4.0/paintbynumbers";
        String apiKey = "YOUR API CREDITS CODE HERE";
        String imageUrl = "https://yourdomainhere/test/exampleimage.png";
        String outputFormat = "svg";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet imageGetRequest = new HttpGet(imageUrl);
            byte[] imageData;

            try (CloseableHttpResponse imageResponse = httpClient.execute(imageGetRequest)) {
                if (imageResponse.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("Error fetching image: " + imageResponse.getStatusLine());
                }

                HttpEntity imageEntity = imageResponse.getEntity();
                imageData = EntityUtils.toByteArray(imageEntity);
            }

            HttpPost request = new HttpPost(url);
            request.setHeader("X-CREDITS-CODE", apiKey);

            HttpEntity requestEntity = MultipartEntityBuilder.create()
                    .addBinaryBody("image", imageData, ContentType.APPLICATION_OCTET_STREAM, "exampleimage.png")
                    .addTextBody("format", outputFormat)
                    .build();

            request.setEntity(requestEntity);

            try (CloseableHttpResponse response = httpClient.execute(request)) {
                if (response.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("HTTP error! status: " + response.getStatusLine());
                }

                HttpEntity responseEntity = response.getEntity();
                String svg = EntityUtils.toString(responseEntity);
                System.out.println(svg);
            }

        } catch (IOException e) {
            System.err.println("Error while converting image to SVG: " + e.getMessage());
        }
    }
}

import requests
from io import BytesIO

def vectorize_image():
    url = "https://api.vectorizer.io/v4.0/paintbynumbers"
    api_key = "YOUR API CREDITS CODE HERE"
    image_url = "https://yourdomainhere/test/exampleimage.png"
    output_format = "svg"

    try:
        image_response = requests.get(image_url)
        image_response.raise_for_status()
        image_data = BytesIO(image_response.content)

        files = {"image": ("exampleimage.png", image_data, "image/png")}
        data = {"format": output_format}
        headers = {"X-CREDITS-CODE": api_key}

        response = requests.post(url, headers=headers, data=data, files=files)
        response.raise_for_status()

        svg = response.text
        print(svg)

    except requests.exceptions.RequestException as error:
        print("Error while converting image to SVG:", error)

vectorize_image()

async function vectorizeImage() {
  const url = "https://api.vectorizer.io/v4.0/paintbynumbers";
  const apiKey = "YOUR API CREDITS CODE HERE";
  const imagePath = "https://yourdomainhere/test/exampleimage.png";
  const outputFormat = "svg";

  try {
    const imageBlob = await fetch(imagePath).then(response => response.blob());

    const formData = new FormData();
    formData.append("image", imageBlob, "exampleimage.png");
    formData.append("format", outputFormat);

    const response = await fetch(url, {
      method: "POST",
      headers: {
        "X-CREDITS-CODE": apiKey
      },
      body: formData
    });

    if (!response.ok) {
      const text = await response.text();
      console.log( text )
      throw new Error(`HTTP error! status: `);
    }

    const svg = await response.text();
    console.log(svg);

  } catch (error) {
    console.error("Error while converting image to SVG:", error);
  }
}

Try it out:

( no credits available. sign in to enable this button )

Request Body ( multipart/form-data )

Responses

Status Code

Description

200

Output format depends on format argument.

HTTP response headers:

X-CREDITS-AVAILABLE	Number of available credits before starting the vectorization operation. This number does not include the one credit that will be charged for a successful download. [this header requires authentication using X-CREDITS-CODE header]
X-CREDITS-EXPIRE	Credits valid until this date (RFC7231 format). [this header requires authentication using X-CREDITS-CODE header]
X-FREE-CREDITS-AVAILABLE	Free credits available. [this header is only available if not authenticated using X-CREDITS-CODE header]
X-COLORCODES	Hex RGB colors codes of vectorization result. First entry has the label '1' in the vector result. (Colors are SPACE separated values of [0-9A-F]{6}): example: '0000FF 00FF00 FF0000'
X-COLORAREAS	Area used by each color in the vectorization result in percent 0 - 100. First entry has the label '1' in the vector result. (Areas are SPACE separated values of decimal percent values): example: '52 0.05 12.5'
X-HREF	Direct URL to the image's edit interface.

500

Error: Internal Server Error.

402

Error: Payment required.

413

Error: Payload too large. (max. 10MB)

429

Error: Too many requests (See Menu / API Settings / API Access Limits for configured api limits for your account)

504

Error: Gateway Timeout

https://api.vectorizer.io/v4.0/vectorize

Advanced vectorization endpoint to covert raster images to scalable vector graphics. (Fragmentation part of url not required). Completion time depends on input image size, number of colors and structure but should never exceed 59 seconds.

# cURL HTTP POST using multipart form upload:

 			
<?php

    // this example requires GuzzleHttp Client. for more information visit: https://docs.guzzlephp.org/en/stable/overview.html#installation
    require 'vendor/autoload.php';
    $client = new GuzzleHttp\Client();
    $res = $client->post('https://api.vectorizer.io/v4.0/vectorize', [
	    'multipart' => [
PARAMS
        ],
        'headers' => [
           'X-CREDITS-CODE' => 'YOUR_CREDITS_CODE_HERE',
        ]
    ]);
    $fp = fopen('exampleimage.svg', 'wb');
    fwrite($fp, $res->getBody());
    fclose($fp);

?>

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class VectorizeImage {
    public static void main(String[] args) {
        vectorizeImage();
    }

    public static void vectorizeImage() {
        String url = "https://api.vectorizer.io/v4.0/vectorize";
        String apiKey = "YOUR API CREDITS CODE HERE";
        String imageUrl = "https://yourdomainhere/test/exampleimage.png";
        String outputFormat = "svg";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet imageGetRequest = new HttpGet(imageUrl);
            byte[] imageData;

            try (CloseableHttpResponse imageResponse = httpClient.execute(imageGetRequest)) {
                if (imageResponse.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("Error fetching image: " + imageResponse.getStatusLine());
                }

                HttpEntity imageEntity = imageResponse.getEntity();
                imageData = EntityUtils.toByteArray(imageEntity);
            }

            HttpPost request = new HttpPost(url);
            request.setHeader("X-CREDITS-CODE", apiKey);

            HttpEntity requestEntity = MultipartEntityBuilder.create()
                    .addBinaryBody("image", imageData, ContentType.APPLICATION_OCTET_STREAM, "exampleimage.png")
                    .addTextBody("format", outputFormat)
                    .build();

            request.setEntity(requestEntity);

            try (CloseableHttpResponse response = httpClient.execute(request)) {
                if (response.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("HTTP error! status: " + response.getStatusLine());
                }

                HttpEntity responseEntity = response.getEntity();
                String svg = EntityUtils.toString(responseEntity);
                System.out.println(svg);
            }

        } catch (IOException e) {
            System.err.println("Error while converting image to SVG: " + e.getMessage());
        }
    }
}

import requests
from io import BytesIO

def vectorize_image():
    url = "https://api.vectorizer.io/v4.0/vectorize"
    api_key = "YOUR API CREDITS CODE HERE"
    image_url = "https://yourdomainhere/test/exampleimage.png"
    output_format = "svg"

    try:
        image_response = requests.get(image_url)
        image_response.raise_for_status()
        image_data = BytesIO(image_response.content)

        files = {"image": ("exampleimage.png", image_data, "image/png")}
        data = {"format": output_format}
        headers = {"X-CREDITS-CODE": api_key}

        response = requests.post(url, headers=headers, data=data, files=files)
        response.raise_for_status()

        svg = response.text
        print(svg)

    except requests.exceptions.RequestException as error:
        print("Error while converting image to SVG:", error)

vectorize_image()

async function vectorizeImage() {
  const url = "https://api.vectorizer.io/v4.0/vectorize";
  const apiKey = "YOUR API CREDITS CODE HERE";
  const imagePath = "https://yourdomainhere/test/exampleimage.png";
  const outputFormat = "svg";

  try {
    const imageBlob = await fetch(imagePath).then(response => response.blob());

    const formData = new FormData();
    formData.append("image", imageBlob, "exampleimage.png");
    formData.append("format", outputFormat);

    const response = await fetch(url, {
      method: "POST",
      headers: {
        "X-CREDITS-CODE": apiKey
      },
      body: formData
    });

    if (!response.ok) {
      const text = await response.text();
      console.log( text )
      throw new Error(`HTTP error! status: `);
    }

    const svg = await response.text();
    console.log(svg);

  } catch (error) {
    console.error("Error while converting image to SVG:", error);
  }
}

Try it out:

( no credits available. sign in to enable this button )

Request Body ( multipart/form-data )

image byte[]	Upload File: Input image binary. Use PNG file format for best compatibility. Try to avoid uploading files larger than 1MB (max. 10MB) to prevent timeouts.
config byte[]	Upload File: Advanced configuration in YAML format. Example configuration: advanced-config-yaml-example-v4.0.7.yaml.
palette byte[]	Upload File: (optional) Import your palette as an .ASE (RGB color space) or .PAL file to vectorize images using ONLY colors from your chosen palette.

Responses

Status Code

Description

200

Output format depends on format argument.

HTTP response headers:

X-CREDITS-AVAILABLE	Number of available credits before starting the vectorization operation. This number does not include the one credit that will be charged for a successful download. [this header requires authentication using X-CREDITS-CODE header]
X-CREDITS-EXPIRE	Credits valid until this date (RFC7231 format). [this header requires authentication using X-CREDITS-CODE header]
X-FREE-CREDITS-AVAILABLE	Free credits available. [this header is only available if not authenticated using X-CREDITS-CODE header]
X-HREF	Direct URL to the image's edit interface.

500

Error: Internal Server Error.

402

Error: Payment required.

413

Error: Payload too large. (max. 10MB)

429

Error: Too many requests (See Menu / API Settings / API Access Limits for configured api limits for your account)

504

Error: Gateway Timeout

https://api.vectorizer.io/v4.0/diamondpainting

Vectorization endpoint for diamond painting images. Completion time depends on input image size, number of colors and structure but should never exceed 59 seconds.

# cURL HTTP POST using multipart form upload:

 			
<?php

    // this example requires GuzzleHttp Client. for more information visit: https://docs.guzzlephp.org/en/stable/overview.html#installation
    require 'vendor/autoload.php';
    $client = new GuzzleHttp\Client();
    $res = $client->post('https://api.vectorizer.io/v4.0/diamondpainting', [
	    'multipart' => [
PARAMS
        ],
        'headers' => [
           'X-CREDITS-CODE' => 'YOUR_CREDITS_CODE_HERE',
        ]
    ]);
    $fp = fopen('exampleimage.svg', 'wb');
    fwrite($fp, $res->getBody());
    fclose($fp);

?>

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class VectorizeImage {
    public static void main(String[] args) {
        vectorizeImage();
    }

    public static void vectorizeImage() {
        String url = "https://api.vectorizer.io/v4.0/diamondpainting";
        String apiKey = "YOUR API CREDITS CODE HERE";
        String imageUrl = "https://yourdomainhere/test/exampleimage.png";
        String outputFormat = "svg";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet imageGetRequest = new HttpGet(imageUrl);
            byte[] imageData;

            try (CloseableHttpResponse imageResponse = httpClient.execute(imageGetRequest)) {
                if (imageResponse.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("Error fetching image: " + imageResponse.getStatusLine());
                }

                HttpEntity imageEntity = imageResponse.getEntity();
                imageData = EntityUtils.toByteArray(imageEntity);
            }

            HttpPost request = new HttpPost(url);
            request.setHeader("X-CREDITS-CODE", apiKey);

            HttpEntity requestEntity = MultipartEntityBuilder.create()
                    .addBinaryBody("image", imageData, ContentType.APPLICATION_OCTET_STREAM, "exampleimage.png")
                    .addTextBody("format", outputFormat)
                    .build();

            request.setEntity(requestEntity);

            try (CloseableHttpResponse response = httpClient.execute(request)) {
                if (response.getStatusLine().getStatusCode() != 200) {
                    throw new IOException("HTTP error! status: " + response.getStatusLine());
                }

                HttpEntity responseEntity = response.getEntity();
                String svg = EntityUtils.toString(responseEntity);
                System.out.println(svg);
            }

        } catch (IOException e) {
            System.err.println("Error while converting image to SVG: " + e.getMessage());
        }
    }
}

import requests
from io import BytesIO

def vectorize_image():
    url = "https://api.vectorizer.io/v4.0/diamondpainting"
    api_key = "YOUR API CREDITS CODE HERE"
    image_url = "https://yourdomainhere/test/exampleimage.png"
    output_format = "svg"

    try:
        image_response = requests.get(image_url)
        image_response.raise_for_status()
        image_data = BytesIO(image_response.content)

        files = {"image": ("exampleimage.png", image_data, "image/png")}
        data = {"format": output_format}
        headers = {"X-CREDITS-CODE": api_key}

        response = requests.post(url, headers=headers, data=data, files=files)
        response.raise_for_status()

        svg = response.text
        print(svg)

    except requests.exceptions.RequestException as error:
        print("Error while converting image to SVG:", error)

vectorize_image()

async function vectorizeImage() {
  const url = "https://api.vectorizer.io/v4.0/diamondpainting";
  const apiKey = "YOUR API CREDITS CODE HERE";
  const imagePath = "https://yourdomainhere/test/exampleimage.png";
  const outputFormat = "svg";

  try {
    const imageBlob = await fetch(imagePath).then(response => response.blob());

    const formData = new FormData();
    formData.append("image", imageBlob, "exampleimage.png");
    formData.append("format", outputFormat);

    const response = await fetch(url, {
      method: "POST",
      headers: {
        "X-CREDITS-CODE": apiKey
      },
      body: formData
    });

    if (!response.ok) {
      const text = await response.text();
      console.log( text )
      throw new Error(`HTTP error! status: `);
    }

    const svg = await response.text();
    console.log(svg);

  } catch (error) {
    console.error("Error while converting image to SVG:", error);
  }
}

Try it out:

( no credits available. sign in to enable this button )

Request Body ( multipart/form-data )

Responses

Status Code

Description

200

Output format depends on format argument.

HTTP response headers:

X-CREDITS-AVAILABLE	Number of available credits before starting the vectorization operation. This number does not include the one credit that will be charged for a successful download. [this header requires authentication using X-CREDITS-CODE header]
X-CREDITS-EXPIRE	Credits valid until this date (RFC7231 format). [this header requires authentication using X-CREDITS-CODE header]
X-FREE-CREDITS-AVAILABLE	Free credits available. [this header is only available if not authenticated using X-CREDITS-CODE header]
X-COLORCODES	Hex RGB colors codes of vectorization result. First entry has the label '1' in the vector result. (Colors are SPACE separated values of [0-9A-F]{6}): example: '0000FF 00FF00 FF0000'
X-COLORAREAS	Area used by each color in the vectorization result in percent 0 - 100. First entry has the label '1' in the vector result. (Areas are SPACE separated values of decimal percent values): example: '52 0.05 12.5'
X-HREF	Direct URL to the image's edit interface.

500

Error: Internal Server Error.

402

Error: Payment required.

413

Error: Payload too large. (max. 10MB)

429

Error: Too many requests (See Menu / API Settings / API Access Limits for configured api limits for your account)

504

Error: Gateway Timeout

image byte[]	Upload File: Input image binary. Use PNG file format for best compatibility. Try to avoid uploading files larger than 1MB (max. 10MB) to prevent timeouts.
format string	Enumeration: svg (Default) eps png Supported output file formats: svg = Scalable Vector Graphics (default) eps = Encapsulated Postscript png = PNG (raster image) Contact us if you need other output file formats.
colors number	Value: ( Default value: 0, Minimum: 0, Maximum: 99 ) Maximum number of colors used to generated the output. A value of 0 is automatic mode.
model string	Enumeration: auto (Default) clipart photo sketch drawing
algorithm string	Enumeration: auto (Default) overlap overlaplow overlapmid overlaphigh nooverlap single strokesingle contour centerline border auto automatic algorithm detection Filled Layers: overlap, overlaplow, overlapmid, overlaphigh nooverlap single Stroked Layers: strokesingle contour centerline border
details string	Enumeration: auto (Default) min low mid high max Other values than auto reduce the detail level in the input image to cluster similar pixels to larger areas. (Only relevant for model: photo, sketch and clipart)
antialiasing string	Enumeration: auto smart min low mid high max off (Default)
minarea integer	Value: ( Default value: 5, Minimum: 0, Maximum: 1000000 ) Minimum area of output shapes in px^2.
colormergefactor integer	Value: ( Default value: 5, Minimum: 0, Maximum: 100 ) Color merge factor in percent. Merges similar output colors to a color group.
unit string	Enumeration: auto (Default) none px inch mm Unit for the width/height for the output file. (Only relevant for SVG output format)
width number	Value: ( Default value: 0, Minimum: 0, Maximum: 1000000 ) A value of 0 is the default value. Other values define the width of the vectorized result in the specified unit. Height will be calculated by ratio of input image (or a specified height value is used).
height number	Value: ( Default value: 0, Minimum: 0, Maximum: 1000000 ) A value of 0 is the default value. Other values define the height of the vectorized result in the specified unit. Width will be calculated by ratio of input image (or a specified width value is used).
transparency-threshold number	Value: ( Default value: 0, Minimum: 0, Maximum: 255 ) (optional) For default behavior omit this parameter or set to value 0. Transparency threshold value. All pixels with a transpareny level below this threshold will be threated as full transparent. If transparency-color is set to a RGB color code, then transparent pixels with be replaced with specified non-transparent color.
transparency-color string	(optional) For default behavior omit this parameter or set to empty string. transparent: keep transparent pixels transparent 000000 replace transparent pixels using black color FF0000 replace transparent pixels using red color
background-threshold number	Value: ( Default value: 0, Minimum: 0, Maximum: 255 ) (optional) For default behavior omit this parameter or set to value 0. Background threshold value. Use a value of 1 to remove background pixels which are the same color as the configured background-color. Use higher values to remove pixels with similar colors.
background-color string	(optional) For default behavior omit this parameter or set to empty string. auto: detect background color automatically 000000 black background color FF0000 red background color
roundness string	Enumeration: off low default (Default) high max (optional) Roundness of generated vector shapes.
palette byte[]	Upload File: (optional) Import your palette as an .ASE (RGB color space) or .PAL file to vectorize images using ONLY colors from your chosen palette.

image byte[]	Upload File: Input image binary. Use PNG file format for best compatibility. Try to avoid uploading files larger than 1MB (max. 10MB) to prevent timeouts.
output string	Enumeration: color contour (Default) bundle color: vectorization result with colors and numbers contour: vectorization result with only the contour lines and numbers (default) bundle: vectorization results in different file formats in ZIP file archive (same as interactive version of the website) (parameter 'format' is ignored for this option)
format string	Enumeration: svg (Default) png Supported output file formats: svg = SVG (default) png = PNG . Contact us if you need other output file formats.
fontsize integer	Value: ( Default value: 60, Minimum: 0, Maximum: 100 ) Maximum font size for the labels representing the color numbers. The default value of 60 might be too large for your use case, then use a smaller value like 12.
colors number	Value: ( Default value: 32, Minimum: 1, Maximum: 99 ) Maximum number of colors used to generated the output. (Recommended: 24, 36, 50)
model string	Enumeration: auto (Default) clipart photo sketch drawing
noisereduction string	Enumeration: off (Default) low high Noise reduction level to improve input image quality. (Use off for most use cases, because other values can add 10-30 seconds of processing time)
details string	Enumeration: auto min low mid high max (Default) Other values than auto reduce the detail level in the input image to cluster similar pixels to larger areas. (Only relevant for model: photo, sketch and clipart)
antialiasing string	Enumeration: auto smart min low mid high max off (Default)
minarea integer	Value: ( Default value: 5, Minimum: 0, Maximum: 1000000 ) Minimum area of output shapes in px^2.
colormergefactor integer	Value: ( Default value: 5, Minimum: 0, Maximum: 100 ) Color merge factor in percent. Merges similar output colors to a color group.
minradius number	Value: ( Default value: 1.5, Minimum: 0, Maximum: 8.0 ) Minimum incircle radius in mm for output shapes. Too remove 'small' non-paintable areas select a higher value. (The radius is related to output width/height in mm)
unit string	Enumeration: auto none px inch mm (Default) Unit for the width/height for the output file.
width number	Value: ( Default value: 0, Minimum: 0, Maximum: 1000000 ) A value of 0 is the default value. Specify '500' for 50cm. Other values define the width of the vectorized result in the specified unit. Height will be calculated by ratio of input image (or a specified height value is used).
height number	Value: ( Default value: 0, Minimum: 0, Maximum: 1000000 ) A value of 0 is the default value. Specify '400' for 40cm. Other values define the height of the vectorized result in the specified unit. Width will be calculated by ratio of input image (or a specified width value is used).
transparency-threshold number	Value: ( Default value: 0, Minimum: 0, Maximum: 255 ) (optional) For default behavior omit this parameter or set to value 0. Transparency threshold value. All pixels with a transpareny level below this threshold will be threated as full transparent. If transparency-color is set to a RGB color code, then transparent pixels with be replaced with specified non-transparent color.
transparency-color string	(optional) For default behavior omit this parameter or set to empty string. transparent: keep transparent pixels transparent 000000 replace transparent pixels using black color FF0000 replace transparent pixels using red color
background-threshold number	Value: ( Default value: 0, Minimum: 0, Maximum: 255 ) (optional) For default behavior omit this parameter or set to value 0. Background threshold value. Use a value of 1 to remove background pixels which are the same color as the configured background-color. Use higher values to remove pixels with similar colors.
background-color string	(optional) For default behavior omit this parameter or set to empty string. auto: detect background color automatically 000000 black background color FF0000 red background color
facedetect string	Enumeration: auto (Default) off true By default the position of faces are detected to improve the detail level of faces. This may produce color patches which are too small to paint, in this case a value of off disables face detection.
roundness string	Enumeration: off low default (Default) high max (optional) Roundness of generated vector shapes.
palette byte[]	Upload File: (optional) Import your palette as an .ASE (RGB color space) or .PAL file to vectorize images using ONLY colors from your chosen palette.

image byte[]	Upload File: Input image binary. Use PNG file format for best compatibility. Try to avoid uploading files larger than 1MB (max. 10MB) to prevent timeouts.
output string	Enumeration: bundle (Default)
colors number	Value: ( Default value: 32, Minimum: 1, Maximum: 99 ) Maximum number of colors used to generated the output. (Recommended: 24, 36, 50)
model string	Enumeration: auto (Default) clipart photo sketch drawing
noisereduction string	Enumeration: off (Default) low high Noise reduction level to improve input image quality. (Use off for most use cases, because other values can add 10-30 seconds of processing time)
details string	Enumeration: auto min low mid high max (Default) Other values than auto reduce the detail level in the input image to cluster similar pixels to larger areas. (Only relevant for model: photo, sketch and clipart)
minarea integer	Value: ( Default value: 5, Minimum: 0, Maximum: 1000000 ) Minimum area of output shapes in px^2.
colormergefactor integer	Value: ( Default value: 5, Minimum: 0, Maximum: 100 ) Color merge factor in percent. Merges similar output colors to a color group.
minradius number	Value: ( Default value: 1.5, Minimum: 0, Maximum: 8.0 ) Minimum incircle radius in mm for output shapes. Too remove 'small' non-paintable areas select a higher value. (The radius is related to output width/height in mm)
unit string	Enumeration: auto none px inch mm (Default) Unit for the width/height for the output file.
width number	Value: ( Default value: 0, Minimum: 0, Maximum: 1000000 ) A value of 0 is the default value. Specify '500' for 50cm. Other values define the width of the vectorized result in the specified unit. Height will be calculated by ratio of input image (or a specified height value is used).
height number	Value: ( Default value: 0, Minimum: 0, Maximum: 1000000 ) A value of 0 is the default value. Specify '400' for 40cm. Other values define the height of the vectorized result in the specified unit. Width will be calculated by ratio of input image (or a specified width value is used).
transparency-threshold number	Value: ( Default value: 0, Minimum: 0, Maximum: 255 ) (optional) For default behavior omit this parameter or set to value 0. Transparency threshold value. All pixels with a transpareny level below this threshold will be threated as full transparent. If transparency-color is set to a RGB color code, then transparent pixels with be replaced with specified non-transparent color.
transparency-color string	(optional) For default behavior omit this parameter or set to empty string. transparent: keep transparent pixels transparent 000000 replace transparent pixels using black color FF0000 replace transparent pixels using red color
background-threshold number	Value: ( Default value: 0, Minimum: 0, Maximum: 255 ) (optional) For default behavior omit this parameter or set to value 0. Background threshold value. Use a value of 1 to remove background pixels which are the same color as the configured background-color. Use higher values to remove pixels with similar colors.
background-color string	(optional) For default behavior omit this parameter or set to empty string. auto: detect background color automatically 000000 black background color FF0000 red background color
roundness string	Enumeration: off low default (Default) high max (optional) Roundness of generated vector shapes.
diamonds string	Enumeration: square25 (Default) round28 (optional) Diamond type: square25: 25mm * 25mm (square) round28: 28mm (round)
palette byte[]	Upload File: (optional) Import your palette as an .ASE (RGB color space) or .PAL file to vectorize images using ONLY colors from your chosen palette.

Version 4.0.14 API Documentation

OpenAPI YAML Definition:

! Important Information !

Client-Side Retry Mechanism

Pricing

Contact

API Security:

API Endpoints:

POST https://api.vectorizer.io/v4.0/vectorize

Try it out:

Request Body ( multipart/form-data )

Responses

POST https://api.vectorizer.io/v4.0/paintbynumbers

Try it out:

Request Body ( multipart/form-data )

Responses

POST https://api.vectorizer.io/v4.0/vectorize

Try it out:

Request Body ( multipart/form-data )

Responses

POST https://api.vectorizer.io/v4.0/diamondpainting

Try it out:

Request Body ( multipart/form-data )

Responses

https://api.vectorizer.io/v4.0/vectorize

https://api.vectorizer.io/v4.0/paintbynumbers

https://api.vectorizer.io/v4.0/vectorize

https://api.vectorizer.io/v4.0/diamondpainting