{"openapi":"3.1.0","info":{"title":"Screenmint Staging API","version":"1.0.0","description":"Screenshots, videos & OG images as an API Screenshots, scrolling page videos, PDFs and Open Graph cards from one REST call. Hosted URLs, free cached renders, no headless browser to babysit.","contact":{"email":"support@smstaging.plxi.us","url":"https://smstaging.plxi.us/contact"},"termsOfService":"https://smstaging.plxi.us/terms"},"externalDocs":{"url":"https://smstaging.plxi.us/docs"},"servers":[{"url":"https://api-smstaging.plxi.us"}],"security":[{"apiKey":[]}],"paths":{"/v1/screenshot":{"post":{"operationId":"screenshot","summary":"Take a screenshot","description":"Render a web page in a real browser and get back the image's public URL. Send `url`; optionally `width` and `height` (the viewport, default 1280x720), `full_page`, `format` (jpeg, png, webp, avif or pdf; default jpeg), `quality`, `scale` (2 for retina, Pro), `delay` (ms after load), `dark_mode`, `selector` (capture one element), `wait_for_selector`, `hide_selectors`, `block_cookies` and `block_ads` (hide cookie banners, ads and pop-ups). Returns `url`, the image's `width` and `height`, `cached` and `render_ms`. The same request within an hour is served from cache and costs nothing.","x-credits":1,"externalDocs":{"url":"https://smstaging.plxi.us/docs#op-screenshot"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"block_ads":{"description":"Block ad and tracker requests and hide marketing pop-ups and chat widgets.","type":["boolean","number","string","null"]},"block_cookies":{"description":"Hide cookie and consent banners.","type":["boolean","number","string","null"]},"dark_mode":{"description":"Render with prefers-color-scheme: dark. Default false.","type":["boolean","number","string","null"]},"delay":{"description":"Milliseconds to wait after the page loads, up to the plan's maximum (Free 5000, Starter 15000, Pro 25000). Default 0."},"format":{"description":"Image format, or pdf. Default jpeg.","enum":["jpeg","png","webp","avif","pdf"]},"full_page":{"description":"Capture the whole page, not just the viewport (up to 20,000 px tall). Default false.","type":["boolean","number","string","null"]},"height":{"description":"Viewport height in pixels, 1 to the plan's maximum (Free 1280, Starter 1080, Pro 1440). Default 720."},"hide_selectors":{"description":"CSS selectors to hide: up to 30, as an array or one comma-separated string.","items":{"type":"string"},"type":["array","string","null"]},"inject_css":{"description":"CSS to add to the page before capturing (up to 20,000 characters).","type":["string","null"]},"inject_js":{"description":"JavaScript to run in the page before capturing (up to 20,000 characters).","type":["string","null"]},"quality":{"description":"JPEG, WebP and AVIF quality, 1 to 100. Default 85."},"scale":{"description":"Device scale factor: 2 renders at retina resolution (Pro). Default 1."},"selector":{"description":"Capture only the first visible element this CSS selector matches.","type":["string","null"]},"template":{"description":"The id of one of your screenshot templates (dashboard, Templates): its settings are the defaults, and what you send overrides them.","type":["string","null"]},"url":{"description":"The page to capture: an http or https URL.","type":"string"},"wait_for_selector":{"description":"A CSS selector to wait for before capturing.","type":["string","null"]},"width":{"description":"Viewport width in pixels, 1 to the plan's maximum (Free 1280, Starter 1920, Pro 2560). Default 1280."}},"required":["url"],"type":"object"},"example":{"format":"jpeg","height":720,"url":"https://example.com","width":1280}}}},"responses":{"200":{"description":"Success. The body includes the credits charged.","content":{"application/json":{"schema":{"properties":{"cached":{"description":"Served from this account's cache, so free.","type":"boolean"},"credits":{"description":"Credits this call was charged.","type":"integer"},"height":{"description":"The image's height in pixels.","type":"integer"},"render_ms":{"type":"integer"},"url":{"description":"Where the image is, on the CDN.","type":"string"},"width":{"description":"The image's width in pixels.","type":"integer"}},"required":["url","width","height","cached","render_ms","credits"],"type":"object"},"example":{"cached":false,"credits":1,"height":720,"render_ms":1840,"url":"https://cdn-smstaging.plxi.us/0b6f3c2e-5f2a-4d6b-9c41-2a7e1d9b8f10/2026-10-28/7d3e2a91-4c1b-4e7a-b0f5-3c8d2e6a1f44.jpeg","width":1280}}}},"400":{"description":"Invalid JSON or input. Not charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit, concurrency limit or monthly quota reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable. Retry with backoff.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/og":{"post":{"operationId":"og","summary":"Make an OG image","description":"Make a 1200x630 social card (Open Graph image) and get back its public URL. Send `title` (up to 80 characters); optionally `description` (160), `site_name` (40), `logo_url`, `bg_color`, `text_color` and `accent_color` (hex, like #0f172a), and a background: `bg_image` (an image URL) or `bg_url` (a page whose screenshot goes behind the text), with `overlay` (0 to 1) to darken it. Returns `url`, `cached` and `render_ms`. The same card within a day is served from cache and costs nothing.","x-credits":1,"externalDocs":{"url":"https://smstaging.plxi.us/docs#op-og"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"accent_color":{"description":"The top bar and site name. Default #000000.","type":["string","null"]},"bg_color":{"description":"Background colour, #rgb or #rrggbb. Default #ffffff.","type":["string","null"]},"bg_image":{"description":"A background image URL (or data: URL).","type":["string","null"]},"bg_url":{"description":"A page whose 1200x630 screenshot is the background.","type":["string","null"]},"description":{"description":"A line under the title, up to 160 characters.","type":["string","null"]},"logo_url":{"description":"A logo image URL (or data: URL), shown above the title.","type":["string","null"]},"overlay":{"description":"How much a background image is darkened, 0 to 1. Default 0.45 with a background."},"site_name":{"description":"Shown at the bottom in the accent colour, up to 40 characters.","type":["string","null"]},"template":{"description":"The id of one of your OG templates (dashboard, Templates): its settings are the defaults, and what you send overrides them.","type":["string","null"]},"text_color":{"description":"Text colour. Default #000000, or #ffffff over a background image.","type":["string","null"]},"title":{"description":"The card's title, up to 80 characters.","type":"string"}},"required":["title"],"type":"object"},"example":{"accent_color":"#7c3aed","bg_color":"#0f172a","description":"Screenshots, OG images and videos from one API.","site_name":"smstaging.plxi.us","text_color":"#ffffff","title":"Ship faster with Screenmint Staging"}}}},"responses":{"200":{"description":"Success. The body includes the credits charged.","content":{"application/json":{"schema":{"properties":{"cached":{"description":"Served from this account's cache, so free.","type":"boolean"},"credits":{"description":"Credits this call was charged.","type":"integer"},"render_ms":{"type":"integer"},"url":{"description":"Where the card is, on the CDN (JPEG).","type":"string"}},"required":["url","cached","render_ms","credits"],"type":"object"},"example":{"cached":false,"credits":1,"render_ms":640,"url":"https://cdn-smstaging.plxi.us/0b6f3c2e-5f2a-4d6b-9c41-2a7e1d9b8f10/2026-10-28/1f9a7c3e-2b6d-4e8a-9c0f-5d4b3a2e1c7f.jpeg"}}}},"400":{"description":"Invalid JSON or input. Not charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit, concurrency limit or monthly quota reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable. Retry with backoff.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/video":{"post":{"operationId":"video","summary":"Record a video","description":"Record a page in a real browser as it loads, animates and (with `scroll`) scrolls from top to bottom, and get back the video's public URL. Send `url`; optionally `seconds` (1 to 30, and the plan's maximum: Free 5, Starter and Pro 30; default 5), `format` (mp4, webm or gif; default mp4), `width` and `height` (default 1280x720), `scroll`, `delay`, `dark_mode`, `hide_selectors`, `block_cookies` and `block_ads`. Returns `url`, `width`, `height`, `seconds`, `format`, `cached` and `render_ms`. With `\"async\": true` at POST /v1/video, Starter and Pro get a smoother frame-by-frame video as a job instead.","x-credits":3,"externalDocs":{"url":"https://smstaging.plxi.us/docs#op-video"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"async":{"description":"At POST /v1/video: queue a smooth frame-by-frame video (Starter and Pro) and answer 202 with a job to poll.","type":["boolean","number","string","null"]},"block_ads":{"description":"Block ad and tracker requests and hide marketing pop-ups and chat widgets.","type":["boolean","number","string","null"]},"block_cookies":{"description":"Hide cookie and consent banners.","type":["boolean","number","string","null"]},"dark_mode":{"description":"Render with prefers-color-scheme: dark.","type":["boolean","number","string","null"]},"delay":{"description":"Milliseconds to wait after the page loads before the clip starts. Default 0."},"format":{"description":"Default mp4.","enum":["mp4","webm","gif"]},"height":{"description":"Viewport height, at least 2, rounded down to even. Default 720."},"hide_selectors":{"description":"CSS selectors to hide: up to 30, as an array or one comma-separated string.","items":{"type":"string"},"type":["array","string","null"]},"scroll":{"description":"Scroll smoothly from the top of the page to the bottom over the clip. Default false.","type":["boolean","number","string","null"]},"seconds":{"description":"Length of the clip in seconds, up to 30 and the plan's maximum (Free 5, Starter 30, Pro 60 as a smooth video). Default 5."},"url":{"description":"The page to record: an http or https URL.","type":"string"},"width":{"description":"Viewport width, at least 2, rounded down to even. Default 1280."}},"required":["url"],"type":"object"},"example":{"format":"mp4","scroll":true,"seconds":5,"url":"https://example.com"}}}},"responses":{"200":{"description":"Success. The body includes the credits charged.","content":{"application/json":{"schema":{"properties":{"cached":{"description":"Served from this account's cache, so free.","type":"boolean"},"credits":{"description":"Credits this call was charged.","type":"integer"},"format":{"type":"string"},"height":{"type":"integer"},"render_ms":{"type":"integer"},"seconds":{"type":"integer"},"url":{"description":"Where the video is, on the CDN.","type":"string"},"width":{"type":"integer"}},"required":["url","width","height","seconds","format","cached","render_ms","credits"],"type":"object"},"example":{"cached":false,"credits":3,"format":"mp4","height":720,"render_ms":9120,"seconds":5,"url":"https://cdn-smstaging.plxi.us/0b6f3c2e-5f2a-4d6b-9c41-2a7e1d9b8f10/2026-10-28/4a2c8e1f-7b3d-4f6a-8e2c-9d1b5a7c3e60.mp4","width":1280}}}},"400":{"description":"Invalid JSON or input. Not charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit, concurrency limit or monthly quota reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable. Retry with backoff.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/video/smooth":{"post":{"operationId":"videoSmooth","summary":"Record a smooth video","description":"Queue a smooth video of a page: captured one fully painted frame at a time at 30 fps, so heavy pages scroll without dropped frames. It takes minutes, so it answers 202 with a job to poll at GET /v1/video/jobs/{job_id}. The same as POST /v1/video with \"async\": true. Starter and Pro only; Starter may have 2 queued or rendering at once, Pro 5.","x-credits":3,"externalDocs":{"url":"https://smstaging.plxi.us/docs#op-video-smooth"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"block_ads":{"description":"Block ad and tracker requests and hide marketing pop-ups and chat widgets.","type":["boolean","number","string","null"]},"block_cookies":{"description":"Hide cookie and consent banners.","type":["boolean","number","string","null"]},"dark_mode":{"description":"Render with prefers-color-scheme: dark.","type":["boolean","number","string","null"]},"delay":{"description":"Milliseconds to wait after the page loads before the clip starts. Default 0."},"format":{"description":"Default mp4.","enum":["mp4","webm","gif"]},"height":{"description":"Viewport height, at least 2, rounded down to even. Default 720."},"hide_selectors":{"description":"CSS selectors to hide: up to 30, as an array or one comma-separated string.","items":{"type":"string"},"type":["array","string","null"]},"scroll":{"description":"Scroll smoothly from the top of the page to the bottom over the clip. Default false.","type":["boolean","number","string","null"]},"seconds":{"description":"Length of the clip in seconds, up to the plan's maximum (Starter 30, Pro 60). Default 5."},"url":{"description":"The page to record: an http or https URL.","type":"string"},"width":{"description":"Viewport width, at least 2, rounded down to even. Default 1280."}},"required":["url"],"type":"object"},"example":{"format":"mp4","scroll":true,"seconds":5,"url":"https://example.com"}}}},"responses":{"202":{"description":"Queued as a job. Poll GET /v1/jobs/{id} for the result.","content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string"},"status":{"type":"string"},"poll_url":{"type":"string"}}}}}},"400":{"description":"Invalid JSON or input. Not charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit, concurrency limit or monthly quota reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable. Retry with backoff.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/batch":{"post":{"operationId":"batch","summary":"Render a batch","description":"Queue up to 50 renders at once: each item is a screenshot (the fields of POST /v1/screenshot) or, with \"kind\": \"og\", an OG card (the fields of POST /v1/og), and may name a `template`. Every item is checked first, and a bad one refuses the batch with its index. It answers 202 with a job to poll at GET /v1/batch/{job_id}, which lists each item's status, result_url or error. At most 2 batches per account run at once.","x-credits":2,"externalDocs":{"url":"https://smstaging.plxi.us/docs#op-batch"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"items":{"description":"1 to 50 items: screenshots, or OG cards with \"kind\": \"og\", each with the fields of its own endpoint."}},"required":["items"],"type":"object"},"example":{"items":[{"height":720,"url":"https://example.com","width":1280},{"kind":"og","title":"Ship faster with Screenmint Staging"}]}}}},"responses":{"202":{"description":"Queued as a job. Poll GET /v1/jobs/{id} for the result.","content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string"},"status":{"type":"string"},"poll_url":{"type":"string"}}}}}},"400":{"description":"Invalid JSON or input. Not charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit, concurrency limit or monthly quota reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Temporarily unavailable. Retry with backoff.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/usage":{"get":{"operationId":"getUsage","summary":"Usage and limits for the current billing period.","responses":{"200":{"description":"Usage summary.","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Stable error code, listed in the API reference."},"message":{"type":"string"},"reset_at":{"type":"string","format":"date-time"}}}}}}