Sketchnote API

Generate visual notes from text or a URL and retrieve the result asynchronously.

Authentication

Paid users can create an API key in Dashboard Settings. Send it as Authorization: Bearer YOUR_API_KEY on each request. Keep your key secret.

The base URL is https://api.sketchnote.app/public/api/v1.

Create an image

Send POST /images with a JSON body containing either content or url, but not both. Optional fields are title, style, orientation, and size. Image generation uses credits.

curl https://api.sketchnote.app/public/api/v1/images \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"content":"Notes from a workshop"}'

A successful request returns HTTP 202 with jobId, status, and pollUrl.

Check a job

Poll GET /images/{jobId} until status is generated or failed. The response includes jobId, noteId, status, and imageUrl; the URL can be null until available and is a signed URL.

Check credits

GET /credits returns an object containing credits.

Errors and limits

Errors return a JSON object with an error message. Common statuses include 400 for invalid input, 401 for an invalid API key, 402 for insufficient credits, 404 for a missing job, and 429 for rate limits or too many concurrent generations. Rate-limited responses may include Retry-After; rate-limit responses also include X-RateLimit-Limit and X-RateLimit-Remaining.

When rate-limit storage is unavailable, image creation and invalid authentication checks return 503; authenticated reads can continue. Retry transient failures with backoff.