canonical: https://jentic.com/apis/pikwy.com/pikwy

# Pikwy Screenshot API

Pikwy is a high-speed screenshot capture API that converts any web page into full-resolution images or PDFs without requiring browser automation infrastructure. The API accepts a single endpoint at api.pikwy.com with flexible parameters for viewport dimensions, device simulation, format selection (PNG, JPG, PDF, HTML), custom delays, JavaScript injection, element hiding, geolocation simulation, and cloud export to S3, Azure, Dropbox, or FTP. Authentication uses an API token parameter that developers obtain from the Pikwy dashboard. Through Jentic, developers can programmatically capture landing pages, social media posts, articles, forum threads, and dynamic web content with a single API call, offloading the complexity of headless browser management, rendering consistency, and high-resolution output generation.

## For AI agents

Capture full-page or viewport-specific screenshots of any URL in PNG, JPG, PDF, or HTML with customizable dimensions, delays, element hiding, and cloud export options.

## Scope

Does not host images, provide CDN delivery, or store screenshots beyond optional direct export to S3/Azure/Dropbox/FTP - use for screenshot capture only, not media asset management or transformation.

## Capabilities

- Capture full-page screenshots of any publicly accessible or authenticated web page in resolutions from 320x240 up to 3840x2160 (4K UHD)
- Render screenshots with device-specific dimensions simulating iPhones, iPads, Android devices, Kindle, and custom viewport sizes
- Export screenshots in PNG, JPG, PDF, or HTML formats with adjustable zoom, scale, and quality settings
- Hide page elements via CSS selectors (useful for removing GDPR banners, cookie notices, or dynamic overlays)
- Inject custom JavaScript, set cookies, customize user-agent headers, and simulate geolocation for location-specific rendering
- Automatically upload screenshots to FTP/SFTP servers, AWS S3 buckets, Azure Blob Storage, or Dropbox
- Authenticate against protected pages using HTTP Basic or form-based login with XPath-targeted field configuration

## Use cases

### Automated Landing Page Archival

Marketing and compliance teams often need timestamped snapshots of landing pages, ads, or promotional content for regulatory audits, A/B test documentation, or historical records. Using Pikwy through Jentic, an agent can capture full-page screenshots at scheduled intervals or on-demand, export them to an S3 bucket with timestamped keys, and maintain an automated archive without managing headless Chrome instances or screenshot infrastructure. The API handles rendering consistency, full-page scrolling, and high-resolution output automatically.

Example prompt: GET https://api.pikwy.com with parameters: token={api_key}, url={target_url}, full_page=1, format=png, and s3_bucket/s3_key for automatic S3 export. Repeat on schedule or trigger.

### Social Media Content Capture

Content moderation, brand monitoring, and social listening tools need to capture social media posts, threads, and comments as durable artifacts. Pikwy supports capturing Facebook posts, Instagram pages, Twitter threads, forum discussions, and YouTube videos in full fidelity. Through Jentic, agents can accept a social media URL, pass it to Pikwy with appropriate delays to allow dynamic content to load, hide cookie banners or overlays via CSS selectors, and return a high-resolution screenshot suitable for evidence collection or reporting dashboards.

Example prompt: GET https://api.pikwy.com with parameters: token={api_key}, url={social_url}, delay=3000, format=png, and css_selector to hide overlays. Return the screenshot for moderation review.

### Competitor Website Monitoring

SEO and competitive intelligence platforms monitor competitor landing pages, product pages, and pricing tables for changes. By scheduling Pikwy captures through Jentic, agents can take daily screenshots of competitor sites, compare them using image diff libraries, and alert users to layout changes, new messaging, or pricing updates. The API's support for custom user-agents, geolocation simulation, and element hiding ensures captures reflect the intended audience experience without test banners or region-locked content.

Example prompt: GET https://api.pikwy.com with parameters: token={api_key}, url={competitor_url}, full_page=1, format=png, geolocation={target_region}. Store the result and compare with previous captures to detect changes.

### Documentation and QA Screenshot Generation

Development teams building documentation, bug reports, or QA test suites need repeatable, high-quality screenshots of application states. Through Jentic, an agent can capture screenshots of staging or production environments with specific viewport sizes (mobile, tablet, desktop), inject JavaScript to set application state or highlight UI elements, and export the results directly to a documentation repository or JIRA attachment. Pikwy eliminates the need for developers to manually take screenshots or maintain Puppeteer scripts.

Example prompt: GET https://api.pikwy.com with parameters: token={api_key}, url={app_url}, width={viewport_width}, height={viewport_height}, js={state_setup_script}, format=png. Attach the result to the documentation or issue tracker.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/` | Capture a screenshot with query parameters for URL, dimensions, format, delays, authentication, and export options |
| POST | `/` | Capture a screenshot with form-encoded or JSON body parameters for URL, dimensions, format, delays, authentication, and export options |

## Key resources

- **Screenshot Endpoint** — Single unified endpoint at api.pikwy.com that accepts GET or POST requests with flexible parameters for URL, dimensions, format, delays, authentication, and export options
- **Output Formats** — PNG, JPG, PDF, and HTML rendering formats with adjustable quality, zoom, and scale settings
- **Device Simulation** — Viewport dimensions covering mobile devices (iPhone, Android), tablets (iPad, Kindle), and desktop resolutions up to 4K UHD (3840x2160)
- **Authentication Methods** — HTTP Basic authentication and form-based login with XPath-targeted field configuration for capturing protected pages
- **Cloud Export Integrations** — Direct upload to AWS S3, Azure Blob Storage, Dropbox, and FTP/SFTP servers without client-side download
- **Advanced Rendering Controls** — Custom JavaScript injection, CSS selector-based element hiding, cookie management, user-agent customization, and geolocation simulation

## Why Jentic

- **Setup:** Wiring the Pikwy Screenshot API by hand means passing its token as a query parameter or body field and coding the capture call and any S3 or FTP export yourself. Through Jentic you install once, import Pikwy from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Pikwy takes the target URL and export settings in the request rather than a resource id in the path, so scoping is by operation: you limit the agent to the screenshot capture calls it needs and leave anything else out. You choose that set, so no operation you did not grant is available to the agent.
- **Credential handling:** Your Pikwy token is stored once, encrypted, by your own Jentic One instance and injected at execution time, along with any S3 or FTP export credentials you add. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'capture a screenshot of a webpage' or 'screenshot a landing page to S3', and Jentic returns the matching Pikwy operation with its parameter schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **urlbox Screenshot API** — urlbox offers screenshot and PDF generation with advanced rendering controls and global edge caching.
- **Cloudinary API** — Cloudinary handles media asset management, transformation, and delivery that pairs with Pikwy-generated screenshots.

## FAQ

### What authentication does the Pikwy Screenshot API use?

The Pikwy API uses API key authentication passed as a query parameter (token or tkn) or in the request body. API keys are obtained from the Pikwy dashboard after account creation. Through Jentic, keys are stored encrypted and injected at execution time so they never appear in agent prompts or transcripts.

### Can I capture screenshots of login-protected pages?

Yes. Pikwy supports both HTTP Basic authentication (via auth_user and auth_pass parameters) and form-based login (via form_user, form_pass, and XPath selectors for field targeting). The API handles login workflows and captures the authenticated page content.

### What image formats does Pikwy support?

Pikwy generates screenshots in PNG, JPG, PDF, and HTML formats. PNG is best for lossless capture, JPG for smaller file sizes, PDF for multi-page documents, and HTML for preserving the original DOM structure alongside rendered content.

### How do I export screenshots directly to S3 through Jentic?

Include the s3_bucket, s3_key, s3_region, s3_access_key, and s3_secret_key parameters in your Pikwy API request. The screenshot will be uploaded directly to the specified S3 location without returning the image to the client. Jentic manages the S3 credentials securely if configured.

### Is there a rate limit for the Pikwy API?

Pikwy enforces usage limits based on your pricing tier. The free trial includes 100 screenshots over 7 days with 1 dedicated worker. Paid plans start at $3/month with 10 dedicated workers and per-screenshot overage pricing. Rate limits are not numerically specified in the API documentation but are enforced account-wide.

### Can I hide cookie banners or GDPR notices in screenshots?

Yes. Use the css_selector parameter to specify CSS selectors for elements you want hidden before the screenshot is captured. This is useful for removing cookie notices, GDPR banners, chat widgets, or other overlays that obscure content. Multiple selectors can be provided.

### Can I limit what my agent is allowed to do with the Pikwy Screenshot API?

Yes. Because you run Jentic One yourself, you decide which Pikwy operations the agent can reach, and your own rules govern which token and export credentials it may use. Pikwy takes the target URL and export settings in each request rather than a resource id in the path, so you scope by operation: grant only the screenshot capture calls (GET or POST to the single endpoint) the agent needs and leave everything else out. Any operation you do not grant is simply unavailable to the agent.