Skip to main content
POST
Generate video with P-Video

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Body

application/json
prompt
string
required

Text description of the video.

aspect_ratio
enum<string>
default:16:9

Aspect ratio. Ignored when a start image already sets the frame.

Available options:
16:9,
9:16,
1:1
audio
string

Optional driving-audio track (MP3/WAV/FLAC). Provide a public audio URL or an uploaded-file URL from POST /v1/uploads (passed by URL, not inlined). When supplied, the video's length matches the audio and length_seconds is ignored — which changes the per-second charge, so estimate via POST /v1/cost.

end_image
string

Optional end frame, used together with image (the start frame) to interpolate the video between the two frames. Same input forms as image.

generate_audio
boolean
default:true

Keep the model's generated audio in the output (default true; no price impact).

image
string

Optional start frame for image-to-video. Provide a public image URL, a data URI, raw base64, or an uploaded-file URL from POST /v1/uploads. Omit for text-to-video.

length_seconds
enum<integer>
default:5

Video length in seconds. Ignored when audio is supplied.

Available options:
5,
10
resolution
enum<string>
default:720p

Output resolution.

Available options:
720p,
1080p
seed
integer

Seed for reproducible generation. Omit for random.

Response

Job accepted.

id
string

Opaque job id — use it to poll status.

message
string
model
string
status
enum<string>

Lifecycle state. succeeded/failed/timeout are terminal.

Available options:
pending,
starting,
processing,
completing,
succeeded,
failed,
timeout