Generate Images

You can use templates to generate a new image with dynamic content like text, images and colors. Add, design and edit your templates in your Placid account.

Endpoint

Method URI
POST /api/rest/{template_uuid}

You can get your {template_uuid} here:

https://placid.app/images/placid-template-id.jpg

Request

This request creates images from your templates. You can add your desired fields and changes into the fields object. By default all images will be created async, which means you have to define a webhook_success URL or poll the same request multiple times until the status is finished;

If you want to have your image without it being queued you have to set create_now to true. You will then get it as fast as possible as soon as your worker is free.

{
  "webhook_success": "https://webhook.url",
  "create_now": false,
  "fields": {},
  "transfer": {
    "to": "s3",
    "key": "<your key>",
    "secret": "<your secret>",
    "region": "<region name>",
    "bucket": "<bucket name>",
    "visibility": "public",

    "path": "images/image.jpg",
    "endpoint": "https://exampleendpoint.com"
  }
}
Field Explanation
webhook_success (optional) After the Image is created we will POST the Response to this Webhook URL
create_now Try to process the Image right away; Might fail if your Worker is too busy
fields Available Fields
transfer If you want to additionally tansfer the generated image to your own storage, define your S3 API compatible bucket credentials (we won't store them anywhere!)
to Only accepts s3 compatible buckets at the moment
visibility Set to public or private
path Define the full image path starting from the root directory of your bucket, including filename and file extension; By default, Placid will overwrite existing files in the specified directory

Response

{
    "id": 1,
    "status": "queued",
    "image_url": null,
    "polling_url": null
}
Field Explanation
id Unique Image id for internal reference
status queued The Request has been put into the queue.
finished The Image has been created successfully.
error There was an error
image_url URL to created Image or null
polling_url You can GET poll this endpoint for status updates