← Tools Reference

Placid

Placid integration (Design & Media, Developer Tools). Imported from open-connector.

API key5 toolshttps://api.placid.app
GET
placid_list_templates
List Placid templates for the connected project with optional collection, title, tag, ordering, or next-page URL filters.

/api/rest/templates

5 parameters
ParamTypeRequiredDescription
collection_idstringoptionalOptional collection UUID used to filter templates.
title_filterstringoptionalOptional title filter applied by Placid.
tagstringoptionalOptional tag filter applied by Placid.
order_bystringoptionalOptional sort string such as `created_at-asc`, `updated_at-desc`, or `title-asc…
page_urlstringoptionalOptional pagination URL previously returned by Placid links; when provided it o…
GET
placid_get_template
Get one Placid template by UUID and return its dynamic layer metadata for downstream image generation.

/api/rest/templates/{template_uuid}

1 parameter
ParamTypeRequiredDescription
template_uuidstringrequiredThe Placid template UUID to retrieve.
POST
placid_create_image
Queue one Placid image generation request from a template UUID and dynamic layer payload, then return the image handle for polling.

/api/rest/images

8 parameters
ParamTypeRequiredDescription
template_uuidstringrequiredThe Placid template UUID to render.
webhook_successstringoptionalOptional webhook URL that Placid should call after the image is generated.
create_nowbooleanoptionalWhether Placid should try to render the image immediately instead of queueing i…
passthroughstringoptional
errorsarrayoptionalOptional error handling flags forwarded to Placid.
layersobjectoptionalThe dynamic layer values keyed by template layer name and forwarded to Placid a…
modificationsobjectoptionalOptional export modifications for the generated image.
transferobjectoptionalOptional transfer settings used to copy the generated image into external stora…
GET
placid_get_image
Get the current Placid image generation status for one image identifier and return the finished image URL when available.

/api/rest/images/{imageId}

2 parameters
ParamTypeRequiredDescription
image_idintegerrequiredThe Placid image identifier returned by create_image.
imageIdstringrequiredPath parameter: imageId
DELETE
placid_delete_image
Delete one Placid image request by identifier and return whether the delete succeeded.

/api/rest/images/{imageId}

2 parameters
ParamTypeRequiredDescription
image_idintegerrequiredThe Placid image identifier to delete.
imageIdstringrequiredPath parameter: imageId