Skip to main content
POST
Generate video with HappyHorse 1.1

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,
4:3,
3:4
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. Can't be combined with reference_images.

length_seconds
integer
default:5

Video length in seconds (4–15).

Required range: 4 <= x <= 15
reference_images
string[]

Optional reference images (1–9) for subject-consistent reference-to-video. Each item is a public image URL, a data URI, raw base64, or an uploaded-file URL from POST /v1/uploads. Can't be combined with image (the start frame).

Maximum array length: 9
resolution
enum<string>
default:720p

Output resolution. Pricing varies by resolution — see resolution_pricing in GET /v1/models.

Available options:
720p,
1080p

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