Generate a video
POST /public/v1/generate-videoGenerates a video with one of Sharek’s AI video providers and saves it to your media
library. The response is the same media row an upload returns, so it drops straight into
a post’s image array.
Doing this in the app? See AI images and video. Also available as
generateVideoTool (MCP), which starts the render and
returns at once instead of waiting; the CLI has no command for it.
| Field | Required | Description |
|---|---|---|
type |
Yes | The video provider to use. Currently veo3 or image-text-slides. |
output |
Yes | vertical or horizontal. Anything else is rejected. |
customParams |
No | Provider-specific options, shaped by the provider’s own schema. |
The available providers
Section titled “The available providers”Two are configured, verified against production on 2026-08-24:
type |
What it makes | Works on a trial |
|---|---|---|
veo3 |
One continuous shot of about 8 seconds, 1080p, with real camera movement, no cuts and no readable text. Optional silent, ambient or spoken audio, and up to 3 reference images. Best for a single vivid moment. | No |
image-text-slides |
A slideshow of 1 to 6 still AI images, each held while a narrator reads it, with captions burned in. Roughly 10 to 55 seconds narrated. Best when the video has several points to make. | Yes |
The set depends on what the deployment has configured, so it can change. To read it back
at any time, send a type you know is wrong: the validation error lists exactly what is
accepted.
{ "statusCode": 400, "message": ["type must be any of: image-text-slides, veo3"], "error": "Bad Request"}Each takes a different customParams shape, so check the provider’s own options before
composing a real request.
Request
Section titled “Request”curl -X POST https://dash.sharek.app/api/public/v1/generate-video \ -H "Authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "type": "video-provider-id", "output": "vertical", "customParams": {} }'Response
Section titled “Response”A media row:
{ "id": "media-id", "name": "a1b2c3d4e5.mp4", "originalName": null, "path": "https://media.example.com/a1b2c3d4e5.mp4", "thumbnail": null, "alt": null, "status": "ready"}Attach it to a post exactly as you would an upload:
"image": [ { "id": "media-id", "path": "https://media.example.com/a1b2c3d4e5.mp4" } ]Errors
Section titled “Errors”| Response | Meaning |
|---|---|
400 field validation |
type is not an available provider, or output is not vertical or horizontal. |
402 |
No AI video credits left for the period. The body carries resetsAt and a url. |
406 This video is not available in trial mode |
The organization is on a trial and this provider does not allow trial use. |
422 Your request was rejected by the AI safety system. ... |
The AI provider refused the request. Change the prompt and try again. |
500 AI generation failed, please try again later. |
The provider ran but produced no result. Retry. |
- Generation consumes AI video credits, which are counted separately from your post quota.
image-text-slidesexposes aloadVoiceshelper for its narration voices. Call it with video provider functions.veo3exposes none.