Skip to content
AAPIScreenshot
All posts
getting-startedtutorialapi

Getting started with the apiscreenshot API

Go from sign-up to your first successful API call in a few minutes. Real curl, Node.js and Python examples against the apiscreenshot endpoint.

The apiscreenshot team2 min read

This is a sample post that ships with the xKit template. It exists so a new product launches with a working, SEO-perfect blog — a real BlogPosting structured-data entry, an RSS feed, related-post links and a clean reading layout — instead of an empty /blog. Replace it with your own first post (it lives at src/content/blog/getting-started-with-the-api.md).

The walkthrough below shows the one thing every xKit product has in common: a single authenticated POST to one endpoint.

The one endpoint

Everything happens at POST https://api.apiscreenshot.com/v1/screenshot. You authenticate with a Bearer API key, send a JSON body, and get a fast, structured response back — there’s no job to poll and nothing to operate on your side.

You’ll need an API key first. Sign up free, then create a key in Dashboard → API keys — it’s shown once at creation, so copy it somewhere safe.

Your first call

Send your payload in the request body. That’s the whole request:

curl https://api.apiscreenshot.com/v1/screenshot \
  -H "Authorization: Bearer sk_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{ "input": "your payload here" }'

The same call in Node.js:

const res = await fetch("https://api.apiscreenshot.com/v1/screenshot", {
  method: "POST",
  headers: {
    Authorization: "Bearer sk_live_YOUR_KEY_HERE",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ input: "your payload here" }),
});

const result = await res.json();

And in Python:

import requests

res = requests.post(
    "https://api.apiscreenshot.com/v1/screenshot",
    headers={"Authorization": "Bearer sk_live_YOUR_KEY_HERE"},
    json={"input": "your payload here"},
)
result = res.json()

What you get back

A 200 with a structured JSON body. Each successful call costs one credit; failed requests (4xx/5xx) are never billed. If something goes wrong you’ll get a JSON error with a stable error code instead — see the Errors reference for the full list.

Where to go next

  • Quickstart — the same flow, condensed to the essential steps.
  • Authentication — how to create, use and rotate API keys.
  • Pricing — plans, the free trial grant, and how metering works.

That’s the whole loop: grab a key, POST your payload, use the result. Swap this post for your own and start telling the story only your product can tell.