> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> API reference for Imejis.io: every `imejisio.api.*` operation with input and output types.

Every `imejisio.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Designs

### render

`designs.render`

Render an Imejis template design into image/PDF bytes or a stored URL

**Risk:** `write`

```ts theme={null}
await corsair.imejisio.api.designs.render({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `designId` | `string` | Yes | The design render code from the design render URL |
| `format` | `png \| jpeg \| webp \| pdf` | No | Output format. Defaults to jpeg per the Imejis OpenAPI spec |
| `quality` | `number` | No | JPEG quality from 1 to 100 (only affects jpeg output) |
| `delivery` | `stream \| hosted \| signed` | No | Delivery mode: stream (raw bytes normalized to base64), hosted (public URL), or signed (expiring URL). Defaults to "stream". |
| `expiresIn` | `number` | No | Signed delivery only: link lifetime in minutes (default 60, maximum 7 days = 10080) |
| `overrides` | `Record<string, any>` | No | Key-value overrides for dynamic design template fields |

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   delivery: stream,
>   format: png | jpeg | webp | pdf,
>   contentType: string,
>   base64: string
> } | {
>   success?: boolean,
>   delivery: hosted,
>   url: string,
>   format?: png | jpeg | webp | pdf,
>   file?: Record<string, any>
> } | {
>   success?: boolean,
>   delivery: signed,
>   url: string,
>   expiresAt?: string,
>   format?: png | jpeg | webp | pdf,
>   file?: Record<string, any>
> }
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.