> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Picnie

> Picnie automates template-based image and PDF generation, image processing, metadata operations, asset uploads, and OCR through its REST API.

![Picnie logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/picnie.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=ee2751eb624e22dab205f1166aa2879f)

* **Category:** images & design
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 19
* **Triggers:** 0
* **Slug:** `PICNIE`
* **Version:** 20261030\_00

## Tools

> [accordion] Add Image Metadata
>
> **Slug:** `PICNIE_ADD_IMAGE_METADATA`
>
> Write EXIF-style metadata into a public JPEG image URL. This creates a processed output and may consume Picnie credits; Picnie's metadata-key allowlist is not fully documented.
>
> #### Input Parameters
>
> **metadata** `object` *required*
>
> EXIF-style key/value object. Documented keys include ImageDescription, Artist, Software, UserComment, Copyright, Make, Model, and DateTimeOriginal; Picnie may reject other keys.
>
> **image\_url** `string` *required*
>
> Publicly accessible JPEG image URL.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Image Watermark
>
> **Slug:** `PICNIE_ADD_IMAGE_WATERMARK`
>
> Overlay a public logo or image URL on a public background image while constraining the output to the required maximum width and height. This image-processing operation may consume Picnie credits.
>
> #### Input Parameters
>
> **position** `string ("top_left" | "top_center" | "top_right" | "middle_left" | "middle_center" | "middle_right" | "bottom_left" | "bottom_center" | "bottom_right")` *required*
>
> Placement of the watermark on the background image.
>
> **max\_width** `integer` *required*
>
> Maximum output width in pixels.
>
> **max\_height** `integer` *required*
>
> Maximum output height in pixels.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> **watermark\_image\_url** `string` *required*
>
> Publicly accessible logo or watermark image URL.
>
> **background\_image\_url** `string` *required*
>
> Publicly accessible background image URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Text Watermark
>
> **Slug:** `PICNIE_ADD_TEXT_WATERMARK`
>
> Overlay styled text on a public image URL. This image-processing operation may consume Picnie credits; supported Picnie font filenames are not fully documented.
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Watermark text to overlay on the image.
>
> **opacity** `number`
>
> Text opacity from 0.0 (transparent) through 1.0 (opaque).
>
> **padding** `integer`
>
> Padding around the watermark text in pixels.
>
> **position** `string ("top-left" | "top-center" | "top-right" | "middle-left" | "middle-center" | "middle-right" | "bottom-left" | "bottom-center" | "bottom-right")` *required*
>
> Placement of the watermark text.
>
> **rotation** `integer`
>
> Clockwise text rotation in degrees.
>
> **font\_size** `integer` *required*
>
> Font size in pixels.
>
> **image\_url** `string` *required*
>
> Publicly accessible source image URL.
>
> **font\_color** `string` *required*
>
> Text color as a six-digit hex value including the leading #.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> **font\_filename** `string` *required*
>
> Picnie-supported font filename from your template or account configuration, not a filesystem path or URL. Picnie does not provide an API for discovering valid filenames, so do not guess this value.
>
> **background\_color** `string`
>
> Text-background color as a six-digit hex value including the leading #.
>
> **background\_opacity** `number`
>
> Text-background opacity from 0.0 (transparent) through 1.0 (opaque).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Apply Image Filter
>
> **Slug:** `PICNIE_APPLY_IMAGE_FILTER`
>
> Apply one supported Picnie visual filter to a public image URL. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **filter** `string ("negate" | "grayscale" | "edge_detect" | "emboss" | "gaussian_blur" | "selective_blur" | "mean_removal")` *required*
>
> Visual filter to apply.
>
> **image\_url** `string` *required*
>
> Publicly accessible source image URL.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Compress Image
>
> **Slug:** `PICNIE_COMPRESS_IMAGE`
>
> Compress a public image URL at a selected Picnie quality and optionally change its format. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **quality** `integer` *required*
>
> Picnie compression quality from 55 (smallest and lowest quality) through 70 (largest and highest quality).
>
> **image\_url** `string` *required*
>
> Publicly accessible source image URL.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> **output\_format** `string ("original" | "jpg" | "png" | "webp")`
>
> Output format, or original to preserve the source format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Image
>
> **Slug:** `PICNIE_CONVERT_IMAGE`
>
> Convert a public image URL to WebP, JPEG, or PNG without asking the agent to choose a compression quality. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **image\_url** `string` *required*
>
> Publicly accessible source image URL.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> **output\_format** `string ("webp" | "jpg" | "png")` *required*
>
> Target image format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Image
>
> **Slug:** `PICNIE_CREATE_IMAGE`
>
> Generate one image from a stored Picnie template and dynamic field replacements. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Destination project ID from List Projects.
>
> **template\_id** `integer` *required*
>
> Image template ID from List Templates.
>
> **replacements** `array` *required*
>
> Dynamic template replacements. Every item needs a field name and exactly one of text or image\_url.
>
> **template\_name** `string` *required*
>
> Exact template name associated with template\_id.
>
> **output\_image\_format** `string ("jpg" | "png" | "gif" | "webp")`
>
> Rendered image format.
>
> **output\_image\_quality** `string ("Maximum" | "High" | "Medium" | "Low")`
>
> Rendered image quality.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Image Collection
>
> **Slug:** `PICNIE_CREATE_IMAGE_COLLECTION`
>
> Generate multiple images from a Picnie template group and shared replacements. This can consume multiple Picnie credits in one call.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Destination project ID from List Projects.
>
> **replacements** `array` *required*
>
> Shared dynamic replacements. Each item requires a field name and exactly one of text or image\_url.
>
> **template\_group\_id** `integer` *required*
>
> Template group ID to render.
>
> **output\_image\_format** `string ("jpg" | "png" | "gif" | "webp")`
>
> Rendered image format.
>
> **output\_image\_quality** `string ("Maximum" | "High" | "Medium" | "Low")`
>
> Rendered image quality.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create PDF
>
> **Slug:** `PICNIE_CREATE_PDF`
>
> Generate a PDF from a stored Picnie template and dynamic field replacements. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Destination project ID from List Projects.
>
> **template\_id** `integer` *required*
>
> PDF template ID from List Templates.
>
> **replacements** `array` *required*
>
> Dynamic template replacements. Every item needs a field name and exactly one of text or image\_url.
>
> **template\_name** `string` *required*
>
> Exact template name associated with template\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Project
>
> **Slug:** `PICNIE_CREATE_PROJECT`
>
> Create a persistent Picnie project for organizing generated and processed media. Picnie exposes no project deletion endpoint, so use this only when a new project is actually needed.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name for the new project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Crop Image
>
> **Slug:** `PICNIE_CROP_IMAGE`
>
> Crop a public image URL to fixed dimensions using horizontal and vertical origin alignment. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **width** `integer` *required*
>
> Crop width in pixels.
>
> **height** `integer` *required*
>
> Crop height in pixels.
>
> **image\_url** `string` *required*
>
> Publicly accessible source image URL.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> **vertical\_origin** `string ("top" | "center" | "bottom")`
>
> Vertical region to retain.
>
> **horizontal\_origin** `string ("left" | "center" | "right")`
>
> Horizontal region to retain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Image Metadata
>
> **Slug:** `PICNIE_GET_IMAGE_METADATA`
>
> Read dimensions, file properties, and EXIF metadata from a public JPEG image URL. Picnie processing may consume credits even though this tool is read-only from the agent's perspective.
>
> #### Input Parameters
>
> **image\_url** `string` *required*
>
> Publicly accessible JPEG image URL.
>
> **project\_id** `string` *required*
>
> Project ID used to authorize the metadata operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template
>
> **Slug:** `PICNIE_GET_TEMPLATE`
>
> Get a Picnie template's complete layout and simplified dynamic fields for constructing generation replacements.
>
> #### Input Parameters
>
> **template\_id** `string` *required*
>
> Template ID from List Templates. Numeric-looking IDs are accepted as strings and resolved by Picnie.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Projects
>
> **Slug:** `PICNIE_LIST_PROJECTS`
>
> List all projects belonging to the connected Picnie account, including IDs needed by generation and processing tools.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates
>
> **Slug:** `PICNIE_LIST_TEMPLATES`
>
> List templates available to the connected Picnie account so an agent can select inputs for image or PDF generation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Image Background
>
> **Slug:** `PICNIE_REMOVE_IMAGE_BACKGROUND`
>
> Use Picnie AI to remove the background from a public image URL. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **image\_url** `string` *required*
>
> Publicly accessible source image URL.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resize Image
>
> **Slug:** `PICNIE_RESIZE_IMAGE`
>
> Resize a public image URL either to explicit pixel dimensions or by percentage. This operation may consume Picnie credits.
>
> #### Input Parameters
>
> **width** `integer`
>
> Target width in pixels; required when resize\_type is dimensions and forbidden for percentage.
>
> **height** `integer`
>
> Target height in pixels; required when resize\_type is dimensions and forbidden for percentage.
>
> **image\_url** `string` *required*
>
> Publicly accessible source image URL.
>
> **project\_id** `string` *required*
>
> Project ID that owns the operation output.
>
> **resize\_type** `string ("dimensions" | "percentage")` *required*
>
> Use dimensions for explicit width and height, or percentage for proportional scaling.
>
> **resize\_percentage** `number`
>
> Scale percentage; required when resize\_type is percentage and forbidden for dimensions.
>
> **prevent\_enlargement** `boolean`
>
> Do not enlarge an image that is already smaller than the requested size.
>
> **maintain\_aspect\_ratio** `boolean`
>
> Maintain the original aspect ratio when resizing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Transcribe Image
>
> **Slug:** `PICNIE_TRANSCRIBE_IMAGE`
>
> Extract text from a public image URL with Picnie OCR. This operation may consume Picnie credits; Picnie currently documents only Original for method and language.
>
> #### Input Parameters
>
> **method** `string`
>
> Picnie OCR method. Original is the only documented value; pass another value only when it is known to be supported by the connected account.
>
> **language** `string`
>
> Picnie OCR language selector. Original is the only documented value; pass another value only when it is known to be supported.
>
> **image\_url** `string` *required*
>
> Publicly accessible image URL to transcribe.
>
> **project\_id** `string` *required*
>
> Project ID used for the OCR operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Asset
>
> **Slug:** `PICNIE_UPLOAD_ASSET`
>
> Upload an image file to the connected Picnie account's persistent media library and return its public URL. Supported formats, size limits, and deletion behavior are not documented.
>
> #### Input Parameters
>
> **image** `object` *required*
>
> Image file to upload. Picnie does not document accepted formats or maximum size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
