OVIOVI API

Name: OVI API
Author: OVI

Straightforward text/image-to-video at 720p with broad style coverage.

Prompt

Start Image

0/1 images

Billed at this model’s published rate.

Result

Your generations will appear here

Install the SDK

TypeScript targets Node 20+ and ships with types; Python needs 3.10+ and is async. Over REST there is nothing to install: call https://api.picsart.com from any HTTP client.

bash

npm install @picsart/ai-sdk

Authenticate

Send your Picsart API key as a bearer token. The SDK does it for you once the client is created.

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

const ai = createClient({
  apiKey: process.env.PICSART_API_KEY, // sent as: Authorization: Bearer <key>
  apiUrl: 'https://api.picsart.com',
});

python

import os

from picsart_ai_sdk import create_client

ai = create_client(
    api_key=os.environ["PICSART_API_KEY"],  # sent as: Authorization: Bearer <key>
    api_url="https://api.picsart.com",
)

Make a request

Call the model by its id. Over REST, one endpoint serves every model: POST /workflows/v1/models/execute with the model id and its input in the body. The outer params is the envelope every workflow takes; the inner one is this model's input, with the same names generate() takes.

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('ovi', {
  prompt: "A serene mountain lake at golden hour, ultra detailed"
});

console.log(result.url); // video URL

python

import asyncio
import os

from picsart_ai_sdk import create_client


async def main() -> None:
    async with create_client(
        api_key=os.environ["PICSART_API_KEY"],
        api_url="https://api.picsart.com",
    ) as ai:
        result = await ai.generate("ovi", {
            "prompt": "A serene mountain lake at golden hour, ultra detailed",
        })

        print(result.url)  # video URL


asyncio.run(main())

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": "ovi",
    "params": {
      "prompt": "A serene mountain lake at golden hour, ultra detailed"
    }
  }
}'

Async (submit & poll)

This model can run longer than the sync limit (~20s). generate() waits for you; to hold on to the job instead, submit it and poll. Over REST, send it to /workflows/v1/models/submit and poll /workflows/v1/models/{taskId}/result until response.status is COMPLETED or FAILED.

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

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

// Returns the generation id at once — store it to pick the job up later.
const generationId = await ai.submit('ovi', {
  prompt: "A serene mountain lake at golden hour, ultra detailed"
});

// Polls until the job completes; throws if it fails or is cancelled.
const result = await ai.result('ovi', generationId);

console.log(result.url); // video URL

python

import asyncio
import os

from picsart_ai_sdk import create_client


async def main() -> None:
    async with create_client(
        api_key=os.environ["PICSART_API_KEY"],
        api_url="https://api.picsart.com",
    ) as ai:
        # Returns the generation id at once — store it to pick the job up later.
        generation_id = await ai.submit("ovi", {
            "prompt": "A serene mountain lake at golden hour, ultra detailed",
        })

        # Polls until the job completes; raises ApiError if it fails or is cancelled.
        result = await ai.result("ovi", generation_id)

        print(result.url)  # video URL


asyncio.run(main())

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": "ovi",
    "params": {
      "prompt": "A serene mountain lake at golden hour, ultra detailed"
    }
  }
}'
# → { "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'

Parameters

3 parameters, the same for the SDK and for the inner params over REST. Required ones must be supplied; the rest fall back to their defaults.

Parameter	Type	Required	Default	Details
`prompt` What to make, in plain language: the subject, style, composition and motion. With an input image or video, what to change.	`text`	yes	`—`	—
`size`	`enum`	no	`16:9`	9:16, 16:9, 1:1, 9:16+, 16:9+, 2:5, 5:2
`imageUrls` Input images, as URLs: frames to animate, or references for subject, style or composition.	`file (image[])`	no	`—`	—

Response

generate() resolves once the job completes. A video URL. Over REST the output is at response.result, inside the gateway's status envelope with the task id, its status and the amount charged.

json

{
  "items": [
    {
      "url": "https://cdn.picsart.com/…/result"
    }
  ],
  "model": "ovi"
}

json

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

Overview

Alongside the unified model APIs, we expose compatibility APIs that take each vendor's original parameters exactly as the vendor defines them — nothing renamed, nothing reshaped on the way through.

That makes them the shortest path onto Picsart if you already work with the vendor directly: the request bodies you've already written keep working as they are. You keep their parameter names and defaults, and you get the vendor's full parameter set rather than the subset that is shared across every model.

The cost is that a request is written for one vendor — switching models later means rewriting it, and results come back in the vendor's own shape. When you'd rather write once and change models freely, use the unified API.

Make a request

Call the workflow with ai.apis.run() in TypeScript or Python, or hit /workflows/{workflow}/execute directly — params is passed through untouched either way.

These endpoints are addressed by workflow name rather than model id: the one in this model's header, since one model runs as one workflow. Authentication is unchanged — your Picsart API key as a bearer token (see Authentication).

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

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

// Calls the 'ovi' workflow directly — params are sent as-is.
const { result, usage } = await ai.apis.run('ovi', {
  prompt: "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>"
}, {
  mode: ApiRunMode.SYNC,
});

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

python

import asyncio
import os

from picsart_ai_sdk import ApiRunMode, create_client


async def main() -> None:
    async with create_client(
        api_key=os.environ["PICSART_API_KEY"],
        api_url="https://api.picsart.com",
    ) as ai:
        # Calls the 'ovi' workflow directly — params are sent as-is.
        response = await ai.apis.run("ovi", {
            "prompt": "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>",
        }, mode=ApiRunMode.SYNC)

        print(response["result"])  # workflow-specific output
        print((response.get("usage") or {}).get("credits"))  # amount charged, in $


asyncio.run(main())

bash

curl -X POST 'https://api.picsart.com/workflows/ovi/execute' \
  -H 'Authorization: Bearer $PICSART_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "prompt": "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>"
  }
}'

Async (submit & poll)

This model can run longer than the sync limit (~20s). In the SDK, ai.apis.run() with ApiRunMode.ASYNC polls for you; over HTTP, submit and poll yourself.

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

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

// mode: ASYNC submits the job and polls under the hood — you just await.
const { result } = await ai.apis.run('ovi', {
  prompt: "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>"
}, {
  mode: ApiRunMode.ASYNC,
});

console.log(result);

python

import asyncio
import os

from picsart_ai_sdk import ApiRunMode, create_client


async def main() -> None:
    async with create_client(
        api_key=os.environ["PICSART_API_KEY"],
        api_url="https://api.picsart.com",
    ) as ai:
        # mode=ASYNC submits the job and polls under the hood — you just await.
        response = await ai.apis.run("ovi", {
            "prompt": "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>",
        }, mode=ApiRunMode.ASYNC)

        print(response["result"])


asyncio.run(main())

bash

# 1. Submit the job
curl -X POST 'https://api.picsart.com/workflows/ovi/submit' \
  -H 'Authorization: Bearer $PICSART_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "prompt": "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>"
  }
}'
# → { "status": "success", "response": { "id": "wf_abc123" } }

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

Parameters

8 parameters, sent inside params. These are the vendor's own names, so they line up one-for-one with the vendor's documentation. Required ones must be supplied; the rest fall back to their defaults.

Parameter	Type	Required	Default	Details
`enable_safety_checker` Authorized callers may set false to request relaxed screening.	`boolean`	no	`true`	—
`resolution` Resolution of the generated video in W:H format. One of (512x992, 992x512, 960x512, 512x960, 720x720, or 448x1120).	`string`	no	`992x512`	`512x992992x512960x512512x960720x720448x11201120x448`
`seed` Random seed for reproducibility. If None, a random seed is chosen.	`integer`	no	`—`	—
`prompt` The text prompt to guide video generation.	`string`	yes	`—`	e.g. `A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>`
`negative_prompt` Negative prompt for video generation.	`string`	no	`jitter, bad hands, blur, distortion`	—
`audio_negative_prompt` Negative prompt for audio generation.	`string`	no	`robotic, muffled, echo, distorted`	—
`num_inference_steps` The number of inference steps.	`integer`	no	`30`	1–50
`options` Platform-specific options for safety checks and Picsart Drive integration.	`object`	no	`—`	—
└`safety_checks` Safety check configuration.	`object`	no	`—`	—
└`enabled` Enable or disable text safety checks. Defaults to true.	`boolean`	no	`true`	—
└`drive` Picsart Drive storage options. When provided, the result will be saved to the user's Drive.	`object`	no	`—`	—
└`name` Filename to save the result as in Picsart Drive.	`string`	yes	`—`	—
└`attributes` Additional file metadata attributes.	`object`	no	`—`	—
└`folder` Destination folder in Picsart Drive.	`object`	no	`—`	—

Response

Over HTTP the output arrives inside a status envelope, at response.result. ai.apis.run() unwraps that envelope for you and resolves to { result, usage } instead. Either way the result itself is the vendor's own shape.

json

{
  "result": {
    "seed": 0,
    "video": {
      "url": "https://storage.googleapis.com/falserverless/example_inputs/ovi_t2v_output.mp4"
    }
  }
}

json

{
  "status": "success",
  "response": {
    "id": "wf_abc123",
    "status": "COMPLETED",
    "result": {
      "seed": 0,
      "video": {
        "url": "https://storage.googleapis.com/falserverless/example_inputs/ovi_t2v_output.mp4"
      }
    }
  }
}

OOVIOVI API

Params

Result

Install the SDK

Authenticate

Make a request

Async (submit & poll)

Parameters

Response

Overview

Make a request

Async (submit & poll)

Parameters

Response

Rates

OVIOVI API