HunyuanHunyuan V3 API
Infographic-friendly generation with readable text and cfg control.
Params
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.
npm install @picsart/ai-sdkpip install picsart-ai-sdkAuthenticate
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',
});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",
)Authorization: Bearer <PICSART_API_KEY>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('hunyuan-v3', {
prompt: "A serene mountain lake at golden hour, ultra detailed",
aspectRatio: "16:9"
});
console.log(result.url); // image URLimport 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("hunyuan-v3", {
"prompt": "A serene mountain lake at golden hour, ultra detailed",
"aspectRatio": "16:9",
})
print(result.url) # image URL
asyncio.run(main())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": "hunyuan-v3",
"params": {
"prompt": "A serene mountain lake at golden hour, ultra detailed",
"aspectRatio": "16:9"
}
}
}'Parameters
5 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 |
|---|---|---|---|---|
promptWhat to make, in plain language: the subject, style and composition. With an input image or video, what to change. | text | yes | — | — |
aspectRatioShape of the output as width:height. An auto or adaptive option follows the input image. | enum | no | 16:9 | 1:1, 16:9, 9:16, 4:3, 3:4 |
countHow many results to make in one call. Each one is charged. | enum | no | 1 | 1, 2, 4 |
negativePromptWhat to keep out of the result, such as text, watermarks or blur. | text | no | — | — |
cfgScaleHow closely the result follows the prompt. Higher is stricter, lower more creative. | range | no | 7.5 | 1–20 (step 0.5) |
Response
generate() resolves once the job completes. One or more image URLs. Over REST the output is at response.result, inside the gateway's status envelope with the task id, its status and the amount charged.
{
"items": [
{
"url": "https://cdn.picsart.com/…/result"
}
],
"model": "hunyuan-v3"
}{
"status": "success",
"response": {
"id": "task_abc123",
"status": "COMPLETED",
"result": {
"url": "https://cdn.picsart.com/…/result",
"items": [
{
"url": "https://cdn.picsart.com/…/result"
}
],
"model": "hunyuan-v3"
}
}
}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 'hunyuan-image/v3/text-to-image' workflow directly — params are sent as-is.
const { result, usage } = await ai.apis.run('hunyuan-image/v3/text-to-image', {
prompt: "200mm telephoto through crowd gaps; subject laughing, candid; creamy background compression, color pop from a single bold garment, catchlight in eyes."
}, {
mode: ApiRunMode.SYNC,
});
console.log(result); // workflow-specific output
console.log(usage?.credits); // amount charged, in $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 'hunyuan-image/v3/text-to-image' workflow directly — params are sent as-is.
response = await ai.apis.run("hunyuan-image/v3/text-to-image", {
"prompt": "200mm telephoto through crowd gaps; subject laughing, candid; creamy background compression, color pop from a single bold garment, catchlight in eyes.",
}, mode=ApiRunMode.SYNC)
print(response["result"]) # workflow-specific output
print((response.get("usage") or {}).get("credits")) # amount charged, in $
asyncio.run(main())curl -X POST 'https://api.picsart.com/workflows/hunyuan-image/v3/text-to-image/execute' \
-H 'Authorization: Bearer $PICSART_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"params": {
"prompt": "200mm telephoto through crowd gaps; subject laughing, candid; creamy background compression, color pop from a single bold garment, catchlight in eyes."
}
}'Parameters
12 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 |
|---|---|---|---|---|
output_formatThe format of the generated image. | string | no | png | jpegpng |
image_sizeThe desired size of the generated image. | ImageSize | string | no | square_hd | — |
promptThe text prompt for image-to-image. | string | yes | — | e.g. 200mm telephoto through crowd gaps; subject laughing, candid; creamy background compression, color pop from a single bold garment, catchlight in eyes. |
num_inference_stepsNumber of denoising steps. | integer | no | 28 | 1–50 |
num_imagesThe number of images to generate. | integer | no | 1 | 1–4 |
enable_prompt_expansionWhether to enable prompt expansion. This will use a large language model to expand the prompt with additional details while maintaining the original meaning. | boolean | no | false | e.g. true |
negative_promptThe negative prompt to guide the image generation away from certain concepts. | string | no | | e.g. blurry, low quality, watermark, signature |
seedRandom seed for reproducible results. If None, a random seed is used. | integer | no | — | — |
enable_safety_checkerIf set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked. | boolean | no | true | — |
sync_modeIf `True`, the media will be returned as a data URI and the output data won't be available in the request history. | boolean | no | false | — |
guidance_scaleControls how much the model adheres to the prompt. Higher values mean stricter adherence. | number | no | 7.5 | 1–20 |
optionsPlatform-specific options for safety checks and Picsart Drive integration. | object | no | — | — |
└ safety_checksSafety check configuration. | object | no | — | — |
└ enabledEnable or disable text safety checks. Defaults to true. | boolean | no | true | — |
└ drivePicsart Drive storage options. When provided, the result will be saved to the user's Drive. | object | no | — | — |
└ nameFilename to save the result as in Picsart Drive. | string | yes | — | — |
└ attributesAdditional file metadata attributes. | object | no | — | — |
└ folderDestination 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.
{
"result": {
"images": [
{
"url": "https://v3b.fal.media/files/b/kangaroo/uIKrZHT6LaGqgXoxtBSn7.png",
"content_type": "image/png"
}
],
"seed": 0
}
}{
"status": "success",
"response": {
"id": "wf_abc123",
"status": "COMPLETED",
"result": {
"images": [
{
"url": "https://v3b.fal.media/files/b/kangaroo/uIKrZHT6LaGqgXoxtBSn7.png",
"content_type": "image/png"
}
],
"seed": 0
}
}
}Rates
What this model costs per generation, in USD. Every row is an exact rate — the columns are the settings that change it.