# The VecSnap API

Every operation an API key may call, generated from the API's own OpenAPI document. The base URL is `https://api.vecsnap.com/v1`.

## Authentication

Send your key as a bearer token: `Authorization: Bearer vs_test_…`. [Keys and test mode](https://vecsnap.com/docs/keys-and-test-mode).

## Errors

Every refusal is `{ error: { code, message, requestId } }`, its HTTP status the code's. [Every code](https://vecsnap.com/docs/errors).

## Pagination

A list answers `{ object: "list", data, hasMore, nextCursor }`. Pass `nextCursor` back as `cursor` for the next page.

## Rate limits

Requests a minute per mode, said on every answer by the `RateLimit` headers. [Limits](https://vecsnap.com/docs/limits).

## The document

The OpenAPI 3.1 document: `https://api.vecsnap.com/v1/openapi`. The SDKs are generated from it; the events are its `webhooks`.

- [Vectorize](https://vecsnap.com/docs/api/vectorize): One call: an image in, its SVG out, waited for in the same request.
- [Uploads](https://vecsnap.com/docs/api/uploads): Files over 4 MB go up first: a URL to PUT the image to, and the key a conversion names it by.
- [Conversions](https://vecsnap.com/docs/api/conversions): Create a conversion, read it, list them, unlock one, follow its progress.
- [Results](https://vecsnap.com/docs/api/results): A completed conversion's files: download one, preview it, read its figures and shapes.
- [Colors](https://vecsnap.com/docs/api/colors): A result's colors: read them, recolor it, keep your brand's palettes.
- [Images](https://vecsnap.com/docs/api/images): Your library: every conversion of the same image is a version of one image.
- [Credits and limits](https://vecsnap.com/docs/api/account): What your account holds and what it may still convert today.
- [Events](https://vecsnap.com/docs/api/events): When a conversion ends, every webhook endpoint of its mode that wants the event receives it, signed.

---
This page: https://vecsnap.com/docs/api