---
canonical_url: "https://docs.composio.dev/toolkits/okzest"
markdown_url: "https://docs.composio.dev/toolkits/okzest.md"
product: "platform"
version: null
last_updated: null
---

# OKZest

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

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

## Tools

### Get Design

**Slug:** `OKZEST_GET_DESIGN`

Return one OKZest design, including its editable URL parameters and usage counters, by design ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `design_id` | string | Yes | Design ID returned by OKZEST_LIST_DESIGNS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `design_id` | string | Yes | Design ID returned by OKZEST_LIST_DESIGNS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum number of designs to return in this page. |
| `page_number` | integer | No | One-based page number to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("gif" | "jpg" | "png" | "webp") | No | Rendered image format. |
| `layers` | array | No | Layer changes to apply only for this render. Get supported layer IDs and property names from OKZEST_GET_DESIGN_FIELDS. |
| `quality` | integer | No | Output quality from 1 to 100 for JPG or WebP; omit for GIF or PNG. |
| `design_id` | string | Yes | Design ID returned by OKZEST_LIST_DESIGNS. |
| `background` | object | No | Optional background overrides for this render. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |