Generate Image


Use a Template to generate a new Image

Endpoint

Method URI
POST /api/rest/{template_uuid}

You can get your {template_uuid} here:

https://placid.app/images/placid-uuid.png

Request

This Request creates images of off your templates - You can add your desired fields/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 your own worker is on it.

{
  "webhook_success": "https://webhook.url",
  "create_now": false,
  "fields": {}
}
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

Response

{
    "id": 1,
    "status": "queued",
    "image_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