Glossary
The words these docs use, each defined in a sentence or two, with a link to where it is explained in full.
Updated
Terms
- API key
A credential that identifies your workspace. Secret keys call the API; publishable keys open the visualizer. More
- Batch
Up to 100 renders sent in one request, checked and charged together or not at all. More
- Credit
The unit renders are paid in: 1 credit a render, from your workspace's plan. More
- Final status
completed, failed or cancelled. A render in a final status never changes again. More
- Idempotency-Key
A header that makes a render request safe to retry: the same key and body are charged once. More
- Image link
A render's image_url: a signed HTTPS link to its image, valid for at least 30 days. More
- Material type
What a product is made of, such as fabric, wood or pavers, when it is known. More
- Origin
Where a scene came from: an upload, Editorial mode, or elsewhere in the workspace. More
- Paint render
A render that repaints walls, ceilings or cabinet fronts in a hex color, with no product. More
- Polling
Fetching a scene or render on a schedule until it reaches a final status. More
- Product
An item in your catalog, rendered by its id. More
- Product type
What kind of surface a product goes on: wall, floor, counter, cabinetry, furniture, furnishing or lighting. More
- Publishable key
A key that is safe in your page's HTML. It only opens the visualizer, and only on the websites listed on it. More
- Rate limit
How many requests a secret key may make in a minute. More
- Render
One product or paint color on one surface of one scene, producing one image. More
- Scene
A room or outdoor space your products render into. More
- Scene lighting
The surface every ready scene has for the room's light as a whole, which lighting products relight. More
- Secret key
A key for your servers that can call every endpoint and spend your credits. Never put one in a browser or app. More
- Setting
Whether a scene is indoor or outdoor, chosen when it is added. More
- Surface
A part of a scene's picture a render can change, such as a wall, a floor or a sofa. More
- Surface type
The kind of a surface, which decides which products fit it. More
- Upscale
An optional enlargement of a finished render, at no extra credit, reported in upscale_status. More
- Visualizer
The website visualizer: a script tag that lets shoppers see your products in a picture of their own room. More
- Workspace
Your Skip Shoot account: its catalog, scenes, credits, keys and team. More
Something these pages do not answer? Email admin@skipshoot.com and we’ll help.