# VecSnap API

> VecSnap turns a PNG, JPG, WebP, AVIF, GIF, BMP or TIFF into a clean SVG with real shapes and few anchor points. One call: POST https://api.vecsnap.com/v1/vectorize with a key from VECSNAP_API_KEY. Test keys (vs_test_) are free.

Every page is also Markdown (add .md). The whole docs in one file: https://vecsnap.com/llms-full.txt. The skill: https://vecsnap.com/docs/skill.md.

## Get started

- [Turn any image into a clean SVG with one call](https://vecsnap.com/docs/index.md): One call to the VecSnap API turns a PNG, JPG, WebP, AVIF, GIF, BMP or TIFF into a clean SVG. Test keys are free.
- [Your first SVG in five minutes](https://vecsnap.com/docs/quickstart.md): Make a test key, send one image to the VecSnap API, and save its SVG: in curl, Node.js or Python.
- [Let your agent do the integration](https://vecsnap.com/docs/build-with-ai.md): One prompt to give Claude, Cursor, ChatGPT or Codex, and every VecSnap doc as Markdown for agents: llms.txt, the skill, the OpenAPI.
- [Keys and test mode](https://vecsnap.com/docs/keys-and-test-mode.md): VecSnap API keys: test keys are free and return a sample result; live keys come with Pro. How to make, roll and revoke them.

## Guides

- [Wait for a result](https://vecsnap.com/docs/wait-for-a-result.md): A VecSnap conversion is asynchronous: wait in the call, poll it, stream its events, or take a webhook when it ends.
- [Webhooks](https://vecsnap.com/docs/webhooks.md): VecSnap webhooks: add an endpoint, receive signed conversion.completed, failed and expired events, verify them, and handle retries.
- [Errors and retries](https://vecsnap.com/docs/errors.md): Every VecSnap API error: its HTTP status, its code, what it means and what to do. Branch on error.code, retry with the same idempotency key.
- [Limits](https://vecsnap.com/docs/limits.md): VecSnap API limits: requests a minute per mode, file sizes, how long a call may wait, and the RateLimit headers.
- [Credits and unlocking](https://vecsnap.com/docs/credits-and-unlocking.md): How the VecSnap API spends credits: one credit unlocks an image and every file of it; re-runs, other formats and failures are free.
- [Formats and downloads](https://vecsnap.com/docs/formats-and-downloads.md): The files a VecSnap conversion makes: the web SVG, the design SVG, PDF and PNG, and how to download each.
- [Go live](https://vecsnap.com/docs/go-live.md): The checklist before your first real image on the VecSnap API: Pro, a live key, live webhooks, idempotency, errors and limits.

## API reference

- [The VecSnap API](https://vecsnap.com/docs/api.md): The VecSnap API reference: its base URL, authentication with a key, the error envelope, paging and rate limits.
- [Vectorize](https://vecsnap.com/docs/api/vectorize.md): One call: an image in, its SVG out, waited for in the same request. Each operation's fields, answers and errors.
- [Uploads](https://vecsnap.com/docs/api/uploads.md): Files over 4 MB go up first: a URL to PUT the image to, and the key a conversion names it by. Each operation's fields, answers and errors.
- [Conversions](https://vecsnap.com/docs/api/conversions.md): Create a conversion, read it, list them, unlock one, follow its progress. Each operation's fields, answers and errors.
- [Results](https://vecsnap.com/docs/api/results.md): A completed conversion's files: download one, preview it, read its figures and shapes. Each operation's fields, answers and errors.
- [Colors](https://vecsnap.com/docs/api/colors.md): A result's colors: read them, recolor it, keep your brand's palettes. Each operation's fields, answers and errors.
- [Images](https://vecsnap.com/docs/api/images.md): Your library: every conversion of the same image is a version of one image. Each operation's fields, answers and errors.
- [Credits and limits](https://vecsnap.com/docs/api/account.md): What your account holds and what it may still convert today. Each operation's fields, answers and errors.
- [Events](https://vecsnap.com/docs/api/events.md): The events VecSnap posts to your webhook endpoints: their types, their envelope and their signature headers.

## SDKs and tools

- [The Node.js SDK](https://vecsnap.com/docs/sdks/node.md): @vecsnap/sdk: the VecSnap API from Node.js, Deno, Bun and edge runtimes, generated from the OpenAPI, with no dependencies.
- [The Python SDK](https://vecsnap.com/docs/sdks/python.md): vecsnap for Python: the VecSnap API in one call, waiting through slow images, with webhook verification. Python 3.9 and later.
- [Command line](https://vecsnap.com/docs/sdks/cli.md): npx vecsnap logo.png: turn an image into a clean SVG from the command line, with your VecSnap API key.