# Ideogram 4.0

> Ideogram's latest model — class-leading text rendering at up to ~3K resolution.

## Overview

- **Model ID**: `ideogram-v4`
- **Workflow**: `ideogram/v4/generate`
- **Provider**: Ideogram
- **Category**: Text → Image (image)
- **Output**: One or more image URLs.
- **Tags**: text rendering, up to 3k, image remix
- **Unified endpoint**: `POST https://api.picsart.com/workflows/v1/models/execute` (model id in the body)
- **Compatibility endpoint**: `POST https://api.picsart.com/workflows/ideogram/v4/generate/execute` (vendor's own parameters)
- **Execution**: sync (`/execute`) returns the result in one call; async is also available
- **Model page**: https://picsart.com/api-platform/models/ideogram-v4

## Pricing

Rates are in USD. Every row below is an exact rate for the settings it names — the columns are the settings that change the price for this model. Every response reports what was actually charged in `response.usage.credits`.

| Tier | Rate |
| --- | --- |
| Turbo | $0.033 / generation |
| Default | $0.066 / generation |
| Quality | $0.11 / generation |

Published rates. Volume pricing, invoicing and annual agreements: https://picsart.com/api-platform/contact-sales

## Authentication

The SDK and the REST API authenticate with a Picsart API key sent as a bearer token. Create a key in the console at https://picsart.com/api-platform/dashboard/api-keys, keep it in a server-side environment variable, and never ship it in browser code or commit it.

```bash
export PICSART_API_KEY="YOUR_KEY"
```

```http
Authorization: Bearer $PICSART_API_KEY
```

The CLI and the MCP server do not use an API key: `gen-ai login` signs in through the browser once per machine and stores a token locally.

## Interfaces

- **SDK** — `@picsart/ai-sdk` (TypeScript, Node 20+, ESM). Type-safe `ai.generate()` / `ai.generateText()` with per-model parameter types; polls long jobs for you.
- **REST** — the API gateway at `https://api.picsart.com`. Sync `/execute`, or async `/submit` + `/{taskId}/result`.
- **CLI** — `@picsart/gen-ai` (`gen-ai`). Generate from a terminal, quote cost before spending, emit JSON for pipelines.
- **MCP** — the same models inside Claude Code, Cursor, Windsurf and other MCP hosts. Setup: https://picsart.com/gen-ai-mcp/

```bash
npm install @picsart/ai-sdk      # SDK
npm install -g @picsart/gen-ai   # CLI (also drives the MCP server)
```

## Unified API (recommended)

One parameter set, used by the SDK and by REST alike: the names below are what `ai.generate('ideogram-v4', …)` takes, and what goes inside the inner `params` of a REST call. Over REST the model id travels in the body, not the path — one workflow, `v1/models`, fronts the whole catalogue.

### Execution modes

- **Sync** — `POST /workflows/v1/models/execute` returns the result in one call. Only for jobs that finish within ~20 seconds; otherwise it times out.
- **Async** — `POST /workflows/v1/models/submit` returns a task id; poll `GET /workflows/v1/models/{taskId}/result` until `response.status` is `COMPLETED` or `FAILED`. Task statuses: `ACCEPTED` · `IN_PROGRESS` · `COMPLETED` · `FAILED`.
- **SDK** — `ai.generate()` always awaits the finished result; polling is hidden.

### Input parameters

- **`prompt`** (`string`, _required_): Prompt
- **`resolution`** (`string`, _optional_)
  - Default: `"2048x2048"`
  - Options: `2048x2048`, `1440x2880`, `2880x1440`, `1664x2496`, `2496x1664`, `1792x2240`, `2240x1792`, `1440x2560`, `2560x1440`, `1600x2560`, `2560x1600`, `1728x2304`, `2304x1728`, `1296x3168`, `3168x1296`, `1152x2944`, `2944x1152`, `1248x3328`, `3328x1248`, `1280x3072`, `3072x1280`, `1024x3072`, `3072x1024`, `1024x1024`, `896x1120`, `1120x896`, `864x1152`, `1152x864`, `832x1248`, `1248x832`, `800x1280`, `1280x800`, `720x1280`, `1280x720`, `720x1440`, `1440x720`, `512x1536`, `1536x512`
- **`renderingSpeed`** (`string`, _optional_)
  - Default: `"DEFAULT"`
  - Options: `TURBO`, `DEFAULT`, `QUALITY`
- **`enableCopyrightDetection`** (`boolean`, _optional_): Copyright Detection
  - Default: `false`
- **`imageUrls`** (`list<string>`, _optional_): Source Image
  - Accepts: image URLs (max 1)
- **`imageWeight`** (`number`, _optional_): Image Weight
  - Default: `50`
  - Range: 1–100 (step 5)

### Input JSON Schema

The inner `params` object. Over REST it is wrapped as `{ "params": { "model": "<id>", "params": <this> } }`; the SDK takes it directly.

```json
{
  "type": "object",
  "required": [
    "prompt"
  ],
  "properties": {
    "prompt": {
      "type": "string",
      "description": "Prompt"
    },
    "resolution": {
      "type": "string",
      "enum": [
        "2048x2048",
        "1440x2880",
        "2880x1440",
        "1664x2496",
        "2496x1664",
        "1792x2240",
        "2240x1792",
        "1440x2560",
        "2560x1440",
        "1600x2560",
        "2560x1600",
        "1728x2304",
        "2304x1728",
        "1296x3168",
        "3168x1296",
        "1152x2944",
        "2944x1152",
        "1248x3328",
        "3328x1248",
        "1280x3072",
        "3072x1280",
        "1024x3072",
        "3072x1024",
        "1024x1024",
        "896x1120",
        "1120x896",
        "864x1152",
        "1152x864",
        "832x1248",
        "1248x832",
        "800x1280",
        "1280x800",
        "720x1280",
        "1280x720",
        "720x1440",
        "1440x720",
        "512x1536",
        "1536x512"
      ],
      "default": "2048x2048"
    },
    "renderingSpeed": {
      "type": "string",
      "enum": [
        "TURBO",
        "DEFAULT",
        "QUALITY"
      ],
      "default": "DEFAULT"
    },
    "enableCopyrightDetection": {
      "type": "boolean",
      "default": false,
      "description": "Copyright Detection"
    },
    "imageUrls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri",
        "description": "image URL"
      },
      "maxItems": 1,
      "description": "Source Image"
    },
    "imageWeight": {
      "type": "number",
      "minimum": 1,
      "maximum": 100,
      "multipleOf": 5,
      "default": 50,
      "description": "Image Weight"
    }
  },
  "additionalProperties": false
}
```

### Required parameters example

The required parameters plus the defaults that shape the output, as a REST body:

```json
{
  "params": {
    "model": "ideogram-v4",
    "params": {
      "prompt": "A serene mountain lake at golden hour, ultra detailed",
      "resolution": "2048x2048"
    }
  }
}
```

### Response

The body is the gateway's status envelope: the output is at `response.result`, next to the task id, its status and the credits charged. Asset models return `url` plus an `items` array of results.

```json
{
  "status": "success",
  "response": {
    "id": "task_abc123",
    "status": "COMPLETED",
    "result": {
      "url": "https://cdn.picsart.com/…/result",
      "items": [
        {
          "url": "https://cdn.picsart.com/…/result"
        }
      ],
      "model": "ideogram-v4"
    }
  }
}
```

What `ai.generate()` / `ai.generateText()` resolve to (the envelope already unwrapped):

```json
{
  "items": [
    {
      "url": "https://cdn.picsart.com/…/result"
    }
  ],
  "model": "ideogram-v4"
}
```

### Usage examples

#### TypeScript (SDK)

```typescript
import { createClient } from '@picsart/ai-sdk';

const ai = createClient({
  apiKey: process.env.PICSART_API_KEY,
  apiUrl: 'https://api.picsart.com',
});

const result = await ai.generate('ideogram-v4', {
  prompt: "A serene mountain lake at golden hour, ultra detailed",
  resolution: "2048x2048"
});

console.log(result.url); // image URL
```

#### cURL (sync)

```bash
curl -X POST 'https://api.picsart.com/workflows/v1/models/execute' \
  -H 'Authorization: Bearer $PICSART_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "model": "ideogram-v4",
    "params": {
      "prompt": "A serene mountain lake at golden hour, ultra detailed",
      "resolution": "2048x2048"
    }
  }
}'
```

#### CLI

```bash
gen-ai login  # once per machine
gen-ai models info ideogram-v4  # this model's parameters
gen-ai pricing ideogram-v4  # quote before spending credits
gen-ai generate -m ideogram-v4 \
  -p "A serene mountain lake at golden hour"
```

## Compatibility API (vendor parameters)

Alongside the unified API, the `ideogram/v4/generate` workflow takes Ideogram's own parameters exactly as the vendor defines them — nothing renamed or reshaped. It is the shortest path onto Picsart for request bodies already written against the vendor; the trade is that a request is written for one vendor, and the result comes back in the vendor's own shape. Same authentication.

- **Endpoint**: `POST https://api.picsart.com/workflows/ideogram/v4/generate/execute` (sync) · `POST …/submit` + `GET …/{taskId}/result` (async)
- **SDK**: `ai.apis.run('ideogram/v4/generate', params, { mode })` — params forwarded verbatim

### Vendor parameters

| Parameter | Type | Required | Default | Details |
| --- | --- | --- | --- | --- |
| `text_prompt` | `string` | no | — | Natural-language prompt. Enables Magic Prompt automatically. Supply exactly one of text_prompt or json_prompt. |
| `json_prompt` | `object` | no | — | Structured V4 prompt object. Disables Magic Prompt; consumed directly. Supply exactly one of text_prompt or json_prompt. |
| `resolution` | `string` | no | — | Output resolution. Omit to let the model pick an aspect ratio. |
| `rendering_speed` | `string` | no | `DEFAULT` | The rendering speed to be used for image generation · Options: `TURBO`, `DEFAULT`, `QUALITY` |
| `enable_copyright_detection` | `boolean` | no | — | Opt into post-generation copyright detection (Hive likeness + logo checks) |
| `storage` | `object` | no | — | Optional storage details specifying where to copy the result file, if provided |
| └ `destination` | `string` | yes | — | Destination bucket name · e.g. `editing-temp` |
| `options` | `object` | no | — | Options controlling safety checks and drive integration |
| └ `safety_checks` | `object` | no | — | Safety check settings |
| └   `enabled` | `boolean` | no | — | Whether to run content moderation. Defaults to true. |
| └ `drive` | `object` | no | — | Save result to Picsart Drive |
| └   `name` | `string` | yes | — | File name in Picsart Drive |
| └   `attributes` | `object` | no | — | Custom attributes to attach to the file |
| └   `folder` | `object` | no | — | Target folder in Picsart Drive |

### Example request body

```json
{
  "params": {
    "text_prompt": "A serene mountain lake at golden hour, ultra detailed"
  }
}
```

### Usage examples

#### TypeScript (`ai.apis.run`)

```typescript
import { createClient, ApiRunMode } from '@picsart/ai-sdk';

const ai = createClient({
  apiKey: process.env.PICSART_API_KEY,
  apiUrl: 'https://api.picsart.com',
});

// Calls the 'ideogram/v4/generate' workflow directly — params are sent as-is.
const { result, usage } = await ai.apis.run('ideogram/v4/generate', {
  text_prompt: "A serene mountain lake at golden hour, ultra detailed"
}, {
  mode: ApiRunMode.SYNC,
});

console.log(result); // workflow-specific output
console.log(usage?.credits); // amount charged, in $
```

#### cURL (sync)

```bash
curl -X POST 'https://api.picsart.com/workflows/ideogram/v4/generate/execute' \
  -H 'Authorization: Bearer $PICSART_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "text_prompt": "A serene mountain lake at golden hour, ultra detailed"
  }
}'
```

### Response

Over HTTP the vendor-shaped result arrives inside the gateway envelope at `response.result`:

```json
{
  "status": "success",
  "response": {
    "id": "wf_abc123",
    "status": "COMPLETED",
    "result": {
      "created": 0,
      "data": [
        {
          "seed": 0,
          "prompt": "…",
          "resolution": "…",
          "url": "https://cdn.picsart.com/…/result.jpg",
          "is_image_safe": true,
          "mimeType": "image/jpeg",
          "driveFile": {}
        }
      ],
      "generation_id": "wf_abc123",
      "seed": 0
    }
  }
}
```

`ai.apis.run()` unwraps that envelope and resolves to `{ result, usage }`:

```json
{
  "result": {
    "created": 0,
    "data": [
      {
        "seed": 0,
        "prompt": "…",
        "resolution": "…",
        "url": "https://cdn.picsart.com/…/result.jpg",
        "is_image_safe": true,
        "mimeType": "image/jpeg",
        "driveFile": {}
      }
    ],
    "generation_id": "wf_abc123",
    "seed": 0
  }
}
```

## Additional resources

- Model page: https://picsart.com/api-platform/models/ideogram-v4
- Try it: https://picsart.com/api-platform/models/ideogram-v4/playground
- SDK: https://picsart.com/api-platform/models/ideogram-v4/sdk
- REST API (unified): https://picsart.com/api-platform/models/ideogram-v4/api
- Compatibility API (vendor parameters): https://picsart.com/api-platform/models/ideogram-v4/advanced
- Pricing: https://picsart.com/api-platform/models/ideogram-v4/pricing
- This document: https://picsart.com/api-platform/models/ideogram-v4/llms.txt
- All models: https://picsart.com/api-platform/models
- Docs — quickstart https://picsart.com/api-platform/docs/quickstart, authentication https://picsart.com/api-platform/docs/authentication, SDK https://picsart.com/api-platform/docs/sdk, REST https://picsart.com/api-platform/docs/api-reference, CLI https://picsart.com/api-platform/docs/cli, MCP https://picsart.com/api-platform/docs/mcp
- CLI reference: https://picsart.github.io/picsart-mcp-cli-docs/guide/introduction