Create image synchronously and get the result in within the same request.
Request Body
Name
Type
Description
modifications
array
Array of modification objects
metadata
object
Extra metadata to be included together with the webhook
webhook_url
string
URL of the webhook to be called when the image is done processing
template
string
The ID of the template
transparent
boolean
Set image background transparency
png_multiplier
integer
Set the quality of PNG image. Must be greater or equal to 1. See Image Quality section.
jpeg_quality
float
Set the quality of JPEG image. Must be between 0 and 1 with 1 being the highest quality. See Image Quality section.
{"id":"05e15531-b80d-4ca0-a658-203d68cd2216","status":"completed","self":"https://api.usestencil.com/v1/images/05e15531-b80d-4ca0-a658-203d68cd2216","log":"{}","metadata":{},"template_id":"1688a5ed-ccdb-477d-a7d5-629a5d4d72ff","webhook_url":null,"webhook_response_body":null,"webhook_response_code":null,"created_at":"2025-09-22T03:52:00.482Z","modifications":[{"name":"category","text":"1...2...3...Bougeons pour I.R.I.S.E"},{"name":"distance","text":"10 KM"},{"name":"logo","src":"https://i.ibb.co/wF2sybRX/Logo-IRISE-2.png"},{"name":"name","text":"Malo J"},{"name":"number","text":"00035"},{"name":"qrcode","value":"https://usestencil.com","visible":false}],"image_url":"https://cdn.usestencil.com/images/1688a5ed-ccdb-477d-a7d5-629a5d4d72ff/05e15531-b80d-4ca0-a658-203d68cd2216.png","image_url_jpg":"https://cdn.usestencil.com/images/1688a5ed-ccdb-477d-a7d5-629a5d4d72ff/05e15531-b80d-4ca0-a658-203d68cd2216.jpeg"}
Create image asynchronously
POSThttps://api.usestencil.com/v1/images
Create image asynchronously. Once image is done processing, the specified webhook is called with the generated image.
Request Body
Name
Type
Description
modifications
array
Array of modifications objects
metadta
object
Extra metadata to be included together with the webhook
webhook_url
string
URL of the webhook to be called when the image is done processing
template
string
The ID of the template
transparent
boolean
Set image background transparency
png_multiplier
integer
Set the quality of PNG image. Must be greater or equal to 1. See Image Quality section.
jpeg_quality
float
Set the quality of JPEG image. Must be between 0 and 1 with 1 being the highest quality. See Image Quality section.
Modification object
Modification object generally follows the following pattern,
name is a required property.
The name is the field unique identifier in the template editor
The rest of the properties depend on the type of object. If you need full list of supported properties, you can view them in them in API Console.
Console shows all available modifications for each template
Image Quality
PNG
For PNG images, you can set png_multiplier to adjust the quality of generated images.
For example, if your template size is 800x800 then setting the png_multiplier to 2 will scale the image to 1600x1600 which creates a higher resolution image.
Please note that higher quality image will increase the image size and will also increase the image generation time.
JPEG
For JPEG images, you can set jpeg_quality to adjust the quality of generated images. JPEG is a lossy format, while it offers higher compression rate that could decrease the file size, it also degrades the image quality.
You can control this by setting jpeg_quality to a number between 0 and 1 with 1 being the highest quality.
Please note that higher quality image will increase the image size and will also increase the image generation time.
Default Settings
You can also set a default settings for all templates in your project. Go to your project's settings page and set the values accordingly.
You can always override these values in the API by following the instructions mentioned above.
Search generated images
POST/v1/images/search?q=<query>
Search for generated images based on your modification inputs. It searches for given query in your modification inputs. Query is case insensitive.
