> ## 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.

# OKZest

> OKZest is a design automation platform for inspecting reusable designs and rendering personalized images through its REST API.

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

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

## Tools

> [accordion] Get Design
>
> **Slug:** `OKZEST_GET_DESIGN`
>
> Return one OKZest design, including its editable URL parameters and usage counters, by design ID.
>
> #### Input Parameters
>
> **design\_id** `string` *required*
>
> Design ID returned by OKZEST\_LIST\_DESIGNS.
>
> #### 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 Design Fields
>
> **Slug:** `OKZEST_GET_DESIGN_FIELDS`
>
> List the editable field descriptors, accepted types, and choices for an OKZest design before rendering it.
>
> #### Input Parameters
>
> **design\_id** `string` *required*
>
> Design ID returned by OKZEST\_LIST\_DESIGNS.
>
> #### 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 Designs
>
> **Slug:** `OKZEST_LIST_DESIGNS`
>
> Return one page of designs available to the connected OKZest account. Use page\_size and page\_number to select the page.
>
> #### Input Parameters
>
> **page\_size** `integer`
>
> Maximum number of designs to return in this page.
>
> **page\_number** `integer`
>
> One-based page number to return.
>
> #### 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] Render Image
>
> **Slug:** `OKZEST_RENDER_IMAGE`
>
> Render an image from an OKZest design with optional temporary layer or background changes. WARNING: each successful call consumes OKZest usage credits or opens. The action sends exactly one render request and does not retry ambiguous failures.
>
> #### Input Parameters
>
> **format** `string ("gif" | "jpg" | "png" | "webp")`
>
> Rendered image format.
>
> **layers** `array`
>
> Layer changes to apply only for this render. Get supported layer IDs and property names from OKZEST\_GET\_DESIGN\_FIELDS.
>
> **quality** `integer`
>
> Output quality from 1 to 100 for JPG or WebP; omit for GIF or PNG.
>
> **design\_id** `string` *required*
>
> Design ID returned by OKZEST\_LIST\_DESIGNS.
>
> **background** `object`
>
> Optional background overrides for this render.
>
> #### 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
