# Picsart Effects Video

> Animate a photo with curated Picsart video presets — multi-step Magic Flow pipelines, one tap.

## Overview

- **Model ID**: `picsart-flow-video`
- **Workflow**: `picsart-flow/v1/effects`
- **Provider**: Picsart
- **Category**: Image → Video (video)
- **Output**: A video URL.
- **Tags**: new, effect presets, image required
- **Unified endpoint**: `POST https://api.picsart.com/workflows/v1/models/execute` (model id in the body)
- **Compatibility endpoint**: `POST https://api.picsart.com/workflows/picsart-flow/v1/effects/execute` (vendor's own parameters)
- **Execution**: long-running — use the async submit/poll pair or the SDK, which polls for you
- **Model page**: https://picsart.com/api-platform/models/picsart-flow-video

## Pricing

Live pricing for this model is not published yet. See https://picsart.com/pricing/ or the Pricing tab of the model page (https://picsart.com/api-platform/models/picsart-flow-video/pricing).

## 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('picsart-flow-video', …)` 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.

Video jobs routinely outrun the sync limit: use async over REST, or the SDK, which polls for you.

### Input parameters

- **`templateId`** (`string`, _required_): Effect Preset
  - An id from the `picsart-flow/v1/catalog/templates` catalog (picsart-flow-video), fetched at runtime via `ai.catalogs`
  - Default: ``
- **`imageUrls`** (`list<string>`, _required_): Your Photo
  - Accepts: image URLs (max 3)

### 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": [
    "templateId",
    "imageUrls"
  ],
  "properties": {
    "templateId": {
      "type": "string",
      "description": "Effect Preset — an id from the `picsart-flow/v1/catalog/templates` catalog (picsart-flow-video)",
      "default": ""
    },
    "imageUrls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri",
        "description": "image URL"
      },
      "maxItems": 3,
      "description": "Your Photo"
    }
  },
  "additionalProperties": false
}
```

### Required parameters example

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

```json
{
  "params": {
    "model": "picsart-flow-video",
    "params": {
      "templateId": "",
      "imageUrls": [
        "https://cdn.example.com/input.jpg"
      ]
    }
  }
}
```

### 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": "picsart-flow-video"
    }
  }
}
```

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

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

### 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('picsart-flow-video', {
  templateId: "",
  imageUrls: [
    "https://cdn.example.com/input.jpg"
  ]
});

console.log(result.url); // video 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": "picsart-flow-video",
    "params": {
      "templateId": "",
      "imageUrls": [
        "https://cdn.example.com/input.jpg"
      ]
    }
  }
}'
```

#### cURL (async: submit, then poll)

```bash
# 1. Submit the job
curl -X POST 'https://api.picsart.com/workflows/v1/models/submit' \
  -H 'Authorization: Bearer $PICSART_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "model": "picsart-flow-video",
    "params": {
      "templateId": "",
      "imageUrls": [
        "https://cdn.example.com/input.jpg"
      ]
    }
  }
}'
# → { "status": "success", "response": { "id": "task_abc123" } }

# 2. Poll until response.status is COMPLETED
curl 'https://api.picsart.com/workflows/v1/models/task_abc123/result' \
  -H 'Authorization: Bearer $PICSART_API_KEY'
```

#### CLI

```bash
gen-ai login  # once per machine
gen-ai models info picsart-flow-video  # this model's parameters
gen-ai pricing picsart-flow-video  # quote before spending credits
gen-ai generate -m picsart-flow-video \
  -i ./input.jpg
```

## Compatibility API (vendor parameters)

Alongside the unified API, the `picsart-flow/v1/effects` workflow takes Picsart'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/picsart-flow/v1/effects/execute` (sync) · `POST …/submit` + `GET …/{taskId}/result` (async)
- **SDK**: `ai.apis.run('picsart-flow/v1/effects', params, { mode })` — params forwarded verbatim

### Vendor parameters

| Parameter | Type | Required | Default | Details |
| --- | --- | --- | --- | --- |
| `template` | `string` | yes | — | Effect template id from picsart-flow/v1/catalog/templates (the Magic Flow id the engine executes) |
| `imageUrls` | `string[]` | yes | — | User images, in slot order — exactly as many as the template's `meta.imageSlots` (1..3) |
| `options` | `object` | no | — | Platform GenAI options. `options.drive` saves the results to the user's Picsart Drive — name, attributes and folder are honored as-is. Safety checks do not apply here (no prompt; the engine moderates its own pipeline via `moderationLevel`) |
| └ `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 |
| └ `inputs_transformation` | `object` | no | — | Input transformation settings |
| └   `downscale_oversized_images` | `boolean` | no | — | Whether to downscale oversized input images. Defaults to false. |
| `moderationLevel` | `string` | no | — | Content moderation strictness level. NONE means no moderation · Options: `none`, `low`, `medium`, `high` |

### Example request body

```json
{
  "params": {
    "template": "your value here",
    "imageUrls": [
      "your value here"
    ]
  }
}
```

### 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 'picsart-flow/v1/effects' workflow directly — params are sent as-is.
const { result, usage } = await ai.apis.run('picsart-flow/v1/effects', {
  template: "your value here",
  imageUrls: [
    "your value here"
  ]
}, {
  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/picsart-flow/v1/effects/execute' \
  -H 'Authorization: Bearer $PICSART_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "template": "your value here",
    "imageUrls": [
      "your value here"
    ]
  }
}'
```

#### cURL (async: submit, then poll)

```bash
# 1. Submit the job
curl -X POST 'https://api.picsart.com/workflows/picsart-flow/v1/effects/submit' \
  -H 'Authorization: Bearer $PICSART_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "template": "your value here",
    "imageUrls": [
      "your value here"
    ]
  }
}'
# → { "status": "success", "response": { "id": "wf_abc123" } }

# 2. Poll until response.status is COMPLETED
curl 'https://api.picsart.com/workflows/picsart-flow/v1/effects/wf_abc123/result' \
  -H 'Authorization: Bearer $PICSART_API_KEY'
```

### 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": {
      "items": [
        {
          "url": "https://cdn.picsart.com/…/result.jpg",
          "type": "…",
          "driveFile": {}
        }
      ]
    }
  }
}
```

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

```json
{
  "result": {
    "items": [
      {
        "url": "https://cdn.picsart.com/…/result.jpg",
        "type": "…",
        "driveFile": {
          "id": "wf_abc123"
        }
      }
    ]
  }
}
```

## Additional resources

- Model page: https://picsart.com/api-platform/models/picsart-flow-video
- Try it: https://picsart.com/api-platform/models/picsart-flow-video/playground
- SDK: https://picsart.com/api-platform/models/picsart-flow-video/sdk
- REST API (unified): https://picsart.com/api-platform/models/picsart-flow-video/api
- Compatibility API (vendor parameters): https://picsart.com/api-platform/models/picsart-flow-video/advanced
- Pricing: https://picsart.com/api-platform/models/picsart-flow-video/pricing
- This document: https://picsart.com/api-platform/models/picsart-flow-video/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