Generate one store image
generate_screenshotTurn one raw screenshot into a single store marketing image for a chosen App Store or Google Play device size, with optional caption, palette and logo. Use it for a quick single image.
Instructions
Turns one raw screenshot into one marketing image for one store size (a list_devices id), with an optional caption, palette and logo. When to use: for a single image or a quick try. For a whole listing (every screen on every required device, one charge) use create_screenshot_set instead. Credits: 1 credit with a live key (ss_live_…), charged when the job is created and refunded automatically if it fails or is canceled before it starts. Test keys (ss_test_…) never spend credits and return sample images of the exact size. Returns the job id at once; pass waitSeconds to wait, or follow it with get_job_status, then download_results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | Yes | ||
| logo | No | ||
| store | Yes | ||
| device | Yes | A list_devices id of the same store. | |
| caption | No | ||
| palette | No | ||
| projectId | No | A Storeshot id. | |
| screenshot | Yes | ||
| orientation | No | ||
| waitSeconds | No | Wait up to this many seconds for the job to finish (0 = return at once). Most clients time out a tool call after about 60 s unless they reset on progress: prefer 50 or less and call get_job_status again. | |
| idempotencyKey | No | Optional: repeating a call with the same key and arguments returns the first job instead of creating another. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| kind | Yes | ||
| next | Yes | ||
| error | Yes | ||
| final | Yes | ||
| store | Yes | ||
| width | Yes | ||
| device | Yes | ||
| height | Yes | ||
| status | Yes | ||
| waited | Yes | ||
| caption | Yes | ||
| imageUrl | Yes | ||
| createdAt | Yes | ||
| finishedAt | Yes | ||
| environment | Yes | ||
| thumbnailUrl | Yes | ||
| urlsExpireAt | Yes | ||
| creditsCharged | Yes | ||
| creditsRefunded | Yes | ||
| screenshotSetId | Yes |