Screenshot API

Capture any social media post as a high-quality PNG image. The platform is auto-detected from the URL you provide.

Endpoint

GET/api/screenshot

Returns a image/png binary on success. All parameters are passed as query strings.

Parameter	Type	Default	Description
postUrl*	string	—	The full URL of the social media post to capture. The platform is auto-detected from the URL.
apiKey*	string	—	Your PostCapture API key (sk_…). See Authentication.

The platform is inferred automatically from the postUrl domain:

These parameters apply to all platforms and control the overall appearance.

Parameter	Type	Default	Description
theme	string	"light"	Card theme. "light" or "dark".
width	number	1200	Output image width in pixels.
padding	number	35	Padding around the card in pixels.
textSize	string	"xl"	Text size preset. One of "sm", "lg", "xl", "2xl", "3xl", "4xl", "5xl", "6xl".
scaleFactor	number	2	Output resolution multiplier (1–4). Use 2 for retina-quality images.
backgroundColor	string	"#B4D455"	Solid background color (hex). Used when backgroundImage is not set.
backgroundImage	string	"linear-gradient(…)"	CSS gradient string for the background.
showWatermark	boolean	true	Show the PostCapture watermark. Paid plans can set this to false.
showShadow	boolean	true	Render a drop shadow behind the card.

Additional parameters when capturing X / Twitter posts.

Parameter	Type	Default	Description
showThread	boolean	false	Load and display the full thread.
showReply	boolean	true	Show the reply button area.
showViewCount	boolean	true	Display the view count.
showFollowerCount	boolean	true	Show the author’s follower count.
showLikeCount	boolean	true	Display the like count.
showRepostCount	boolean	true	Display the repost count.
showBookmarkCount	boolean	true	Display the bookmark count.
showDate	boolean	true	Show the post date.
showMedia	boolean	true	Include images/videos in the capture.
showLinkCards	boolean	true	Render URL preview cards.
showReplyTo	boolean	true	Show the "Replying to" label.
showFullQuote	boolean	true	Expand quoted tweets inline.
showQuoteMedia	boolean	true	Show media in quoted tweets.
showCommunity	boolean	true	Show community badge if applicable.

Parameter	Type	Default	Description
showReply	boolean	true	Show the reply area.
showLikeCount	boolean	true	Display the like count.
showRepostCount	boolean	true	Display the repost count.
showDate	boolean	true	Show the post date.
showFollowerCount	boolean	true	Show follower count.
showMedia	boolean	true	Include images in the capture.
showLinkCards	boolean	true	Render URL preview cards.
showQuoteMedia	boolean	true	Show media in quotes.

Parameter	Type	Default	Description
youtubeFormat	string	"landscape"	Layout: "landscape" or "portrait".
showPostedSince	boolean	true	Show relative post time.
showFollowerCount	boolean	true	Show subscriber count.
showLikeCount	boolean	true	Display the like count.
showViewCount	boolean	true	Display the view count.

Parameter	Type	Default	Description
tiktokFormat	string	"landscape"	Layout: "landscape" or "portrait".
showTikTokMusic	boolean	true	Show the sound/music info.
showTikTokDescription	boolean	true	Show the video description.
showFollowerCount	boolean	true	Show follower count.
showLikeCount	boolean	true	Display the like count.

Returns the screenshot as a PNG binary with these headers:

Content-Type	image/png
Cache-Control	public, max-age=60

All errors return JSON with an error field:

400Bad Request

1{
2  "error": "Missing required parameter: postUrl"
3}

401Unauthorized

1{
2  "error": "Invalid API key",
3  "details": "KEY_NOT_FOUND"
4}

429Rate Limit Exceeded

1{
2  "error": "Rate limit exceeded",
3  "message": "Too many requests. Limit is 10 per minute. Try again in 42s.",
4  "retryAfterMs": 42000
5}

500Server Error

1{
2  "error": "Screenshot generation failed: timeout"
3}