Docs

GET STARTED

Your first SVG in five minutes

A test key, one request, one file. Test keys are free: every image becomes the same sample result, so you can build the whole integration before you spend anything.

1. Get a test key

Sign in and open Developers. Create a test key: it starts with vs_test_ and is shown once. Keep it in an environment variable, never in your code.

Terminal
export VECSNAP_API_KEY=vs_test_…

2. Install a client (optional)

npm install @vecsnap/sdk

curl needs nothing. The SDKs wait for a slow image for you, and turn every refusal into one error type with its code.

3. Send an image

curl https://api.vecsnap.com/v1/vectorize \
  -H "Authorization: Bearer $VECSNAP_API_KEY" \
  -H "Accept: image/svg+xml" \
  -F file=@logo.png \
  -L -o logo.svg

The file goes as form data, up to 4 MB. Larger files, up to 10 MB, go through an upload. A link works too: send url instead of file.

4. Read what came back

The answer is the conversion: its status, its result with anchorPoints, fileSize and formats, and files, a short-lived link to each SVG. With Accept: image/svg+xml curl gets the file itself.

A slow image answers 202.Most images finish in seconds; a few take minutes. Past wait seconds (30 by default) the API answers 202 with the conversion, which finishes by itself. The SDKs wait for it. With curl, read it again or take a webhook.

Next

WebhooksHear about every conversion as it ends.
Errors and retriesEvery code and what to do.
Go liveFrom a test key to real images.