Placid
App · Images & Design · 4 actions
Generate branded images and PDFs from your Placid templates: fill in the layers and get back a ready-to-use file.
Actions
| Action | What it does |
|---|---|
| Create image | Generate an image from a Placid template, filling in its layers. |
| Create PDF | Generate a PDF from a Placid template, filling in its layers. |
| Get image | Check a previously created image and get its URL once finished. |
| Get PDF | Check a previously created PDF and get its URL once finished. |
Create image
Generate an image from a Placid template, filling in its layers. Returns the image URL once it's ready.
Inputs
- Template
template_uuidtextRequired - The Placid template to generate from.
- Layers
layersobjectRequired - The content for each of the template's layers. Text layers take text; picture layers take an image URL. Leave a layer blank to keep the template's default.
Outputs
idnumber- The image's ID (use it to poll).
imageUrltext- URL of the finished image, or empty while queued.
pollingUrltext- URL to check the image's status.
statustext- 'queued', 'finished', or 'error'.
Example output
{
"id": 1,
"imageUrl": "https://placid.app/u/generated-image.png",
"pollingUrl": "https://api.placid.app/api/rest/images/1",
"status": "finished"
}Create PDF
Generate a PDF from a Placid template, filling in its layers. PDFs are queued; use 'Get PDF' to fetch the finished file.
Inputs
- Template
template_uuidtextRequired - The Placid template to generate from.
- Layers
layersobjectRequired - The content for each of the template's layers. Text layers take text; picture layers take an image URL. Leave a layer blank to keep the template's default.
Outputs
idnumber- The PDF's ID (use it to poll).
pdfUrltext- URL of the finished PDF, or empty while queued.
pollingUrltext- URL to check the PDF's status.
statustext- 'queued', 'finished', or 'error'.
Example output
{
"id": 1,
"pdfUrl": "",
"pollingUrl": "https://api.placid.app/api/rest/pdfs/1",
"status": "queued"
}Get image
Check a previously created image and get its URL once finished.
Inputs
- Image ID
image_idtextRequired - The ID returned by 'Create image'.
Outputs
idnumber- The image's ID (use it to poll).
imageUrltext- URL of the finished image, or empty while queued.
pollingUrltext- URL to check the image's status.
statustext- 'queued', 'finished', or 'error'.
Example output
{
"id": 1,
"imageUrl": "https://placid.app/u/generated-image.png",
"pollingUrl": "https://api.placid.app/api/rest/images/1",
"status": "finished"
}Get PDF
Check a previously created PDF and get its URL once finished.
Inputs
- PDF ID
pdf_idtextRequired - The ID returned by 'Create PDF'.
Outputs
idnumber- The PDF's ID (use it to poll).
pdfUrltext- URL of the finished PDF, or empty while queued.
pollingUrltext- URL to check the PDF's status.
statustext- 'queued', 'finished', or 'error'.
Example output
{
"id": 1,
"pdfUrl": "",
"pollingUrl": "https://api.placid.app/api/rest/pdfs/1",
"status": "queued"
}