The render lifecycle
A render is one product, or one paint color, on one surface of one scene. It moves through a few statuses and ends with an image or a refund.
Updated
What a render is
One render is one thing on one surface of one scene: a fabric on the sofa, a floor on the floor, a color on the walls. It makes one image, and costs 1 credit.
Create renders with Create renders and follow each one with Retrieve a render. Every render has its own id, even when it was sent in a batch.
Render statuses
| Status | Means | Final? |
|---|---|---|
| queued | Charged and waiting to start. It can still be cancelled. | No |
| rendering | Being made. | No |
| upscaling | Made, and being upscaled. Only when an upscale was asked for and is available. | No |
| completed | Done: image_url links to the image. | Yes |
| failed | Could not be made. error says why, and the credit was given back. | Yes |
| cancelled | Cancelled while still queued. | Yes |
How statuses change
- A render only moves forward, and a final status never changes.
- Every render reaches a final status. One that stops making progress for 10 minutes is marked
failedand its credit given back, so a poll that waits for a final status always ends. - A queued render can fail before it starts, for example if its product is removed from your catalog while it waits. Its credit is given back too.
- If an upscale fails, the render still completes, with the image as it was rendered. Its
upscale_statussays so. See Upscaling.
How long renders take
Once it starts, most renders finish in about 20 to 60 seconds. Times vary with the image and how busy the service is, so some take longer, and none is guaranteed.
Queue and order
- Each workspace’s renders run 3 at a time, shared by all of its keys.
- They start in the order they were sent, including the order inside a batch.
- So a full batch of 100 takes roughly 22 minutes or more. Plan for minutes, not seconds, and collect each image as it arrives.
Failed renders and refunds
A failed render costs nothing: its credit goes back to your workspace without you asking. Its error says what went wrong, in words you can show your team.
Cancelling
A queued render can be cancelled with Cancel a render, and its credit comes back, unless it was taken before your workspace’s credits last renewed. Once a render is rendering it runs to the end.
Renders in the app
Renders made through the API appear in your workspace’s gallery in Skip Shoot, marked as made by the API, so your team can see, share and download them like any other.
Something these pages do not answer? Email admin@skipshoot.com and we’ll help.
