Create an explainer video
create_videoStarts a narrated explainer video from a topic or script and returns the video object (status queued). Free videos have a watermark and are 60 seconds or less in 720p; balance videos use the account balance and have no watermark (get_options lists the costs). Send a unique idempotency_key per video so a retry never makes a second video.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"prompt": "<prompt>"
},
"name": "create_video"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Optional. plan: uses the weekly videos of the person's GenPixy subscription, no watermark. balance: uses the account balance, no watermark. free: watermark, 60 seconds or less in 720p, a daily limit; only in AI apps connected with GenPixy sign-in. Default: plan when the person has a subscription that covers this length; else free when GenPixy is connected in an AI app and the options allow it; else balance. When the subscription's videos are used up, the answer says when they come back and how to use the balance instead: ask the person before you spend their balance. | |
| music | No | ||
| style | No | whiteboard: hand-drawn whiteboard animation. animate: cartoon animation with characters. flat: Color Board (bold colored scenes). | whiteboard |
| voice | No | male | |
| prompt | Yes | A topic, notes, or a full script. Line breaks and Markdown lists are fine. Write it in the language the narration should use. | |
| seconds | No | Target length. | |
| language | No | auto: narration follows the prompt language (76 languages). | auto |
| big_board | No | All scenes on one board with a zoom-out recap at the end. | |
| subtitles | No | ||
| zoom_dive | No | The camera flies into an icon when the next scene looks closer at it. | |
| resolution | No | 720p | |
| orientation | No | landscape | |
| idempotency_key | No | Optional. One unique string per video, for example a UUID. A retry with the same value returns the same video. The HTTP API also takes it as the Idempotency-Key header. |