From a player screenshot to a report
The player chooses to attach a screenshot in your game. Let them preview it and hide private information before sending. The SDK uploads the selected image through the existing Player Reports API; the server validates it and stores a sanitized copy. Once processing completes, open Player reports in the dashboard for the same game and environment. Click the thumbnail or message to see the full screenshot and context. Under More filters, choose Screenshots only to find image reports.
Player-submitted screenshots are separate from Playtest → job → Screenshots, which contains AI playtest evidence. A processing receipt means the image was accepted for checking, not that it is already visible in the inbox. Expired images leave the report text available.
JavaScript game canvas
// After the player chooses to attach an image, preview it in your UI.
const screenshot = await rs.captureScreenshot(gameCanvas);
const report = await rs.createReport({
message: 'The cave door stays locked after collecting three keys.',
category: 'bug', level: 'cave', screenshot,
context: { keys: 3 }
});
const receipt = await rs.submitReport(report);
// If processing, check again later from your UI, not in a tight loop.
const status = await rs.getReportStatus(report);
// status.status === 'complete': status.reportId is in Player reports.
Capture is opt-in and limited to the supplied game canvas. It does not capture the desktop. You may instead pass your own PNG, JPEG or WebP bytes. Keep the prepared report object for retries on the same SDK instance; do not create a new ID after a timeout. The SDK keeps the original session, never silently submits a second report under a new session, and never silently replaces a failed screenshot with text. A text-only report is an explicit player choice.
Images must be at most 1,000,000 bytes and 4,000,000 pixels. Capture helpers scale within 1600×1600. Screenshot hashing in the browser requires HTTPS or localhost. Reports count as one event plus 20,000 events for the image. Unfinished uploads expire after 15 minutes; failed or canceled images release reserved usage. Images are retained for 90 days, subject to delivery limits, and are not automatically sent to AI providers.
SDK support
All nine SDKs submit a Player Report with a screenshot. Godot adds an optional overlay that captures the game viewport and lets the player highlight and redact before sending, and JavaScript's captureScreenshot captures only the game canvas you pass it. The other seven take an image your game already encoded after the player chose to attach it: Unity, Unreal, C++, iOS and Android accept PNG, JPEG or WebP (iOS a UIImage, Android a Bitmap or bytes), and LÖVE and Odin accept PNG bytes. No SDK captures the desktop, and an image is sent only when you pass one. Use the SDK README for its consent flow. Ordinary text feedback and error events never upload images; do not treat analytics event properties as file uploads.
For a direct integration, use the existing session token: POST /api/v1/reports with a stable clientId, capturedAt, message and image size/SHA-256; request POST /api/v1/reports/:id/upload; send the returned fields and file as a multipart POST to the presigned storage URL without API credentials; then POST /api/v1/reports/:id/finalize. Read GET /api/v1/reports/:id until complete or canceled. Retrying uses the same payload, ID and session. Public ingest keys must allow allow_reports. Never embed studio credentials in a game.