Skip to navigation

HappyHorse 1.1

Animate one or more images into a 3–15 second video at 720p or 1080p. An image is required.

  • Asynchronous: the create call returns a task ID; the video arrives when the task succeeds.
  • Image to video only: images is required (1 to 9 links). There is no text-to-video mode.
  • Clips of 3 to 15 seconds; duration is a whole number of seconds.
  • Billed by the resolution and the number of seconds you request. A failed task costs nothing.
POST/v1/videos/tasksTry it

Opens this model in the API Explorer. Enter your BeatAPI API key to create a task: the call is real and is billed to your own balance.

Model IDs

Two HappyHorse models share this endpoint and accept exactly the same request. The values below come straight from the gateway contract.

Model IDduration (s)resolutionaspect_ratioMax imagesNotes
happyhorse-1.03–15720p, 1080p16:9, 9:16, 1:1, 4:3, 3:49The first HappyHorse model. Not on the live model list: create answers 503 with the code processing_unavailable.
happyhorse-1.13–15720p, 1080p16:9, 9:16, 1:1, 4:3, 3:49Same fields and limits as 1.0.

Endpoint and authentication

POST https://api.beatapi.io/v1/videos/tasks

Authorization string Required

Your BeatAPI API key, sent as Bearer <BEATAPI_API_KEY>. Create keys in the Dashboard. Keep keys on your server; never ship them in a browser or mobile app.

Send the body as JSON with Content-Type: application/json. Idempotency-Key is optional: send a unique value (at most 255 characters) per logical request and reuse it only to retry that exact body. Within 24 hours a retry with the same key and body returns the first response again with Idempotent-Replayed: true; the same key with a different body returns 409 idempotency_conflict. Responses other than 2xx are not stored, so a retry after a 400 or 402 runs again.

How a request works

1

Create the task

POST the parameters below to the endpoint. A 201 means the task was accepted and its price reserved from your balance; the work runs in the background. Save data.id.

2

Wait for it to finish

Call GET /v1/tasks/{task_id} and wait data.poll_after_seconds between calls (5 s for images, 8 s for videos) until status is succeeded or failed. Or register a webhook for task.succeeded and task.failed; keep polling as the fallback, because a task stopped by the processing timeout sends no event.

3

Save the result

On succeeded, download every data.output.media[].url and store the files you need; BeatAPI does not promise how long result URLs stay available. On failed, read data.error_code and data.error_message: the reserved amount was returned to your balance, and data.retryable says whether sending the same request again can succeed.

Input modes

ModeRequired inputsNotes
One imagemodel, prompt, images (1 link)The video is made from this image.
Several imagesmodel, prompt, images (2 to 9 links)The images are passed to the model in list order.

Request parameters

model string Required

The model to run.

Value: happyhorse-1.1

If the value is wrong

  • Missing: "model" is required
  • An image model sent to this endpoint: "model" nano-banana-2 is served by POST /v1/images/tasks, not this endpoint

prompt string Required

What happens in the video: the motion, the expression and the camera.

Length: 1–5000 characters

  • Length is counted in characters (a CJK character counts as one).

If the value is wrong

  • Missing: "prompt" is required
  • Empty or longer than the limit: "prompt" has an unsupported length
  • Not a string: "prompt" must be a string

images string[] Required

The picture to animate, or several pictures in the order you want them used. Required.

Items: 1–9
Each item is a public https:// URL. For a local file, upload it first with POST /v1/files and pass the returned data.url.

  • Each link must be a public https:// URL. The gateway does not download or measure the files when the task is created.
  • This model has no text-to-video mode: a request without images is refused.
  • aspect_ratio and resolution keep their defaults (16:9, 720p) when you leave them out, because the gateway does not read them from the image. Send the shape you want.

If the value is wrong

  • Missing: "images" is required
  • More than 9 links: "images" accepts at most 9 items
  • Empty array: "images" requires at least 1 item
  • Not an array: "images" must be an array
  • Not an https:// link: "images[0]" must be a public HTTPS URL

duration integer OptionalDefault: 5

Length of the video in seconds, a whole number.

Default: 5
Range: 3–15

  • If you leave it out, 5 is used and billed.
  • Seconds are billed (see Billing), so this is the main lever on the price.

If the value is wrong

  • Outside 3–15, not a whole number, or sent as a string: "duration" is outside its supported range

aspect_ratio string OptionalDefault: 16:9

Shape of the video as width:height.

Allowed values: 16:9, 9:16, 1:1, 4:3, 3:4
Default: 16:9

  • If you leave it out, 16:9 is used, also when the image is portrait.
  • adaptive is not offered by this model.

If the value is wrong

  • A value not in the list: "aspect_ratio" must be one of: [16:9 9:16 1:1 4:3 3:4]

resolution string OptionalDefault: 720p

Output resolution. 1080p costs more per second than 720p.

Allowed values: 720p, 1080p
Default: 720p

  • Lower case only.

If the value is wrong

  • A value not in the list (for example 480p or 720P): "resolution" must be one of: [720p 1080p]

Input media limits

The gateway reads every input before the task is created and refuses one outside these limits with a 400 bad_request that names the input. Nothing is charged.

  • The gateway does not read your image files when it creates the task, so no size, resolution or format limit is checked for this model; only the field rules above apply.
  • A link the model cannot fetch or use fails the task after it was created, usually with bad_request (or content_policy_violation when moderation refuses an input), and the task is refunded in full.
  • Have a local file? Upload it with POST /v1/files (png, jpg, jpeg or webp; up to 50 MB) and pass the returned data.url.

Fields this model does not accept

Sending one of these is refused before anything is charged, instead of being ignored:

  • reference_images, reference_videos, reference_audios, generate_audio, seed, quality, sound, task_type, output_format, watermark and the other fields of other video models → field "reference_videos" is not supported by model happyhorse-1.1 (with the field you sent). Put pictures in images.
  • Any field the video endpoint does not know at all → unknown field: <name>.

Request examples

curl --request POST \
--url https://api.beatapi.io/v1/videos/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "happyhorse-1.1",
"prompt": "The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights",
"images": [
"https://media.beatapi.io/samples/neon-singer.png"
],
"duration": 5,
"aspect_ratio": "9:16",
"resolution": "720p"
}'

Image to video

A 5-second 720p portrait clip made from one image.

curl --request POST \
--url https://api.beatapi.io/v1/videos/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "happyhorse-1.1",
"prompt": "The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights",
"images": [
"https://media.beatapi.io/samples/neon-singer.png"
],
"duration": 5,
"aspect_ratio": "9:16",
"resolution": "720p"
}'

Several images

Two images, passed to the model in list order, as a 10-second 1080p clip.

curl --request POST \
--url https://api.beatapi.io/v1/videos/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "happyhorse-1.1",
"prompt": "The camera pushes in from the bottle on the table to the singer on a neon stage in one continuous move",
"images": [
"https://media.beatapi.io/samples/smart-bottle.png",
"https://media.beatapi.io/samples/neon-singer.png"
],
"duration": 10,
"aspect_ratio": "16:9",
"resolution": "1080p"
}'

Responses

Create a task (201)

The task object. output is null until the task succeeds. Fields marked “while running” disappear once the task finishes.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "video",
"capability_id": "happyhorse-1.1",
"capability_version": 1,
"media_type": "video",
"model": "happyhorse-1.1",
"status": "queued",
"stage": "queued",
"created_at": 1791993600,
"updated_at": 1791993600,
"completed_at": null,
"poll_after_seconds": 8,
"output": null,
"usage": {
"credits_reserved": 0.5625,
"credits_settled": 0,
"credits_refunded": 0,
"credits_charged": 0.5625,
"billable_duration_seconds": 5
},
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": null,
"error_message": null
}
}
FieldTypeDescription
data.idstringTask ID: task_ followed by 32 letters and digits. Use it to poll and to match webhook events.
data.objectstringAlways task.
data.task_kindstringimage or video.
data.capability_idstringThe model ID you sent.
data.capability_versionintegerContract version of the model, currently 1.
data.media_typestringimage or video.
data.modelstringThe model ID you sent (same as capability_id).
data.statusstringqueued, processing, succeeded or failed. Only the last two are final.
data.stagestringRepeats status; kept for older clients.
data.created_atintegerWhen the task was created, Unix seconds.
data.updated_atintegerLast change, Unix seconds.
data.completed_atinteger | nullWhen the task finished, Unix seconds; null while it runs.
data.poll_after_secondsintegerWhile running: how long to wait before the next poll (5 for images, 8 for videos).
data.typical_secondsobjectWhile running, when enough recent tasks exist: p50 and p90 completion times in seconds over the last window, from samples tasks.
data.outputobject | nullThe result; null until status is succeeded. See the output fields below.
data.usage.credits_reservednumberUSD held from your balance when the task was created.
data.usage.credits_chargednumberUSD this task costs; 0 on a failed task.
data.usage.credits_settlednumberUSD finally taken; set when the task succeeds, otherwise 0.
data.usage.credits_refundednumberUSD returned to your balance; equals the reservation on a failed task once the refund is recorded.
data.usage.billable_duration_secondsintegerVideo only: the seconds the price is based on. Absent when the model reports no duration.
data.request_idstringRequest ID. Include it when you contact support.
data.error_codestring | nullFailure code; null unless the task failed.
data.error_messagestring | nullWhat went wrong and what to change; null unless the task failed.

Finished task

GET /v1/tasks/{task_id} returns HTTP 200 with status: "succeeded" and the result in data.output.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "video",
"capability_id": "happyhorse-1.1",
"capability_version": 1,
"media_type": "video",
"model": "happyhorse-1.1",
"status": "succeeded",
"stage": "succeeded",
"created_at": 1791993600,
"updated_at": 1791993690,
"completed_at": 1791993690,
"output": {
"media": [
{
"type": "video",
"url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.mp4",
"mime_type": "video/mp4"
}
],
"r2_url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.mp4"
},
"usage": {
"credits_reserved": 0.5625,
"credits_settled": 0.5625,
"credits_refunded": 0,
"credits_charged": 0.5625,
"billable_duration_seconds": 5
},
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": null,
"error_message": null
}
}

Output fields

FieldTypeDescription
output.mediaobject[]The generated files; one video for this model.
output.media[].typestringAlways video.
output.media[].urlstringHTTPS link to the stored video. Download and keep it; no retention period is promised.
output.media[].mime_typestringvideo/mp4.
output.r2_urlstringThe video URL again, for older clients. Read media instead.

Failed task

A failed task is still HTTP 200 on GET /v1/tasks/{task_id}: the failure is in the body. The reservation is returned in full, so nothing is charged.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "video",
"capability_id": "happyhorse-1.1",
"capability_version": 1,
"media_type": "video",
"model": "happyhorse-1.1",
"status": "failed",
"stage": "failed",
"created_at": 1791993600,
"updated_at": 1791993690,
"completed_at": 1791993690,
"output": null,
"usage": {
"credits_reserved": 0.5625,
"credits_settled": 0,
"credits_refunded": 0.5625,
"credits_charged": 0,
"billable_duration_seconds": 5
},
"retryable": true,
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": "processing_failed",
"error_message": "The task failed during processing on our side. Retry; a failed task is refunded."
}
}
FieldTypeDescription
data.error_codestringOne of bad_request and content_policy_violation (change the request) or processing_unavailable, processing_timeout, processing_failed and result_transfer_failed (try again later). See Errors.
data.error_messagestringA sentence that names the problem and the fix.
data.retryablebooleanPresent only on a failed task: true when the same request can succeed if you send it again.
data.usageobjectOnce the refund is recorded (normally at the moment the task fails): credits_charged and credits_settled are 0, and credits_refunded equals credits_reserved.

Complete example

Create a task, wait for it with the server’s polling hint, and print the result URLs. Set BEATAPI_API_KEY in your environment and install requests.

import os
import time
import uuid
import requests
API = "https://api.beatapi.io"
HEADERS = {"Authorization": f"Bearer {os.environ['BEATAPI_API_KEY']}"}
def create_task(body: dict) -> dict:
# One Idempotency-Key per logical request: a retry with the same key cannot create a second task.
headers = {**HEADERS, "Idempotency-Key": str(uuid.uuid4())}
for attempt in range(3):
response = requests.post(f"{API}/v1/videos/tasks", headers=headers, json=body, timeout=60)
if response.status_code in (429, 503) and attempt < 2:
time.sleep(int(response.headers.get("Retry-After", 10)))
continue
break
try:
payload = response.json()
except ValueError: # an edge error page is not JSON
response.raise_for_status()
raise
if not response.ok:
error = payload["error"]
raise RuntimeError(f"{response.status_code} {error['code']}: {error['message']} (request_id={error.get('request_id')})")
return payload["data"]
def wait_for_task(task_id: str, timeout_seconds: int = 1800) -> dict:
deadline = time.monotonic() + timeout_seconds
while time.monotonic() < deadline:
response = requests.get(f"{API}/v1/tasks/{task_id}", headers=HEADERS, timeout=30)
if response.status_code == 429 or response.status_code >= 500:
time.sleep(int(response.headers.get("Retry-After", 10)))
continue
response.raise_for_status()
task = response.json()["data"]
if task["status"] in ("succeeded", "failed"):
return task
time.sleep(task.get("poll_after_seconds", 5))
raise TimeoutError(f"task {task_id} is still running; keep polling later")
task = create_task({
"model": "happyhorse-1.1",
"prompt": "The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights",
"images": [
"https://media.beatapi.io/samples/neon-singer.png"
],
"duration": 5,
"aspect_ratio": "9:16",
"resolution": "720p"
})
print("created", task["id"])
task = wait_for_task(task["id"])
if task["status"] == "failed":
raise SystemExit(f"{task['error_code']}: {task['error_message']}")
for item in task["output"]["media"]:
print(item["url"])

Billing

  • The price follows the resolution and the number of seconds you request (duration, 5 if you leave it out). 1080p costs more per second than 720p. aspect_ratio and the number of images do not change it.
  • The table below shows 8-second clips; other lengths are priced per second at the same rate for their resolution.
  • The price is reserved when the task is created; data.usage.billable_duration_seconds shows the seconds it is based on.
  • A failed task, including one refused by moderation after submission, is refunded in full.

Current list prices, the same as on Pricing. An account with a negotiated discount pays less; data.usage on the task always shows the amount actually charged.

OptionList price (USD)
8 sec · 720p$0.9
8 sec · 1080p$1.16

Common errors

Error or symptomCauseFix
400 "images" is requiredNo images in the request. This model cannot make a video from text alone.Send 1 to 9 image links in images.
400 "images" accepts at most 9 itemsMore than 9 image links.Send at most 9.
400 "duration" is outside its supported rangeBelow 3, above 15, a decimal, or a string.Send an integer from 3 to 15, such as 8.
400 "resolution" must be one of: [720p 1080p]480p, 4k, or upper case such as 720P.Send 720p or 1080p.
400 "aspect_ratio" must be one of: [16:9 9:16 1:1 4:3 3:4]adaptive, 21:9 or another ratio this model does not offer.Send one of the listed ratios.
400 field "reference_videos" is not supported by model happyhorse-1.1This model takes images only; reference videos, reference audio and other video fields are refused.Remove the field.
Task failed with bad_requestAn image link the model could not fetch or use (a private or expired link, a file that is not an image).Use a public HTTPS link to a real image, or upload it with POST /v1/files. The failed task was refunded.
Task failed with content_policy_violationThe prompt, an input or the result was refused by moderation.Change the prompt or the image. Retrying unchanged fails again; nothing is charged.
402 insufficient_creditsThe balance is below the price reserved for the request; long clips at 1080p cost the most.Top up, shorten duration, or use 720p.

HTTP errors at a glance

Errors before a task exists arrive as a non-2xx response, and nothing is charged. Branch on error.code or error.retryable; message names the problem. The full list and retry policy are on Errors.

{
"error": {
"code": "bad_request",
"message": "\"prompt\" is required",
"retryable": false,
"request_id": "req_5f0c2a9e4b7d4e31"
}
}
HTTP statuserror.codeWhat to do
400bad_request, content_policy_violationFix the request; the message names the field. Do not retry unchanged.
401missing_api_key, invalid_api_key (older clients may see unauthorized)Send a valid key as Authorization: Bearer <key>.
402insufficient_creditsTop up, or raise the key’s quota, then send it again.
403forbiddenThe key or account may not use this model (for example, free credit only covers some models). Do not retry unchanged.
404not_foundOn GET /v1/tasks/{task_id}: the task does not exist for this key’s account. Check the ID.
409idempotency_conflictUse a new Idempotency-Key, or wait for the first request with this key to finish.
429rate_limit_exceededWait Retry-After seconds (also error.retry_after_seconds), then retry.
500internal_errorRetry with backoff; contact support with request_id if it continues.
503processing_unavailable, processing_timeout, processing_failed, result_transfer_failedNothing was charged. Retry with exponential backoff.

Authentication

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

Headers

Idempotency-KeystringOptional<=255 characters

Send the body as JSON with Content-Type: application/json. Idempotency-Key is optional: send a unique value (at most 255 characters) per logical request and reuse it only to retry that exact body. Within 24 hours a retry with the same key and body returns the first response again with Idempotent-Replayed: true; the same key with a different body returns 409 idempotency_conflict. Responses other than 2xx are not stored, so a retry after a 400 or 402 runs again.

Request

This endpoint expects an object.
imageslist of stringsRequired

The picture to animate, or several pictures in the order you want them used. Required.

Items: 1–9

Each item is a public https:// URL. For a local file, upload it first with POST /v1/files and pass the returned data.url.

  • Each link must be a public https:// URL. The gateway does not download or measure the files when the task is created.
  • This model has no text-to-video mode: a request without images is refused.
  • aspect_ratio and resolution keep their defaults (16:9, 720p) when you leave them out, because the gateway does not read them from the image. Send the shape you want.

If the value is wrong

  • Missing: "images" is required
  • More than 9 links: "images" accepts at most 9 items
  • Empty array: "images" requires at least 1 item
  • Not an array: "images" must be an array
  • Not an https:// link: "images[0]" must be a public HTTPS URL
modelenumRequired

The model to run.

Value: happyhorse-1.1

If the value is wrong

  • Missing: "model" is required
  • An image model sent to this endpoint: "model" nano-banana-2 is served by POST /v1/images/tasks, not this endpoint
Allowed values:
promptstringRequired1-5000 characters

What happens in the video: the motion, the expression and the camera.

Length: 1–5000 characters

  • Length is counted in characters (a CJK character counts as one).

If the value is wrong

  • Missing: "prompt" is required
  • Empty or longer than the limit: "prompt" has an unsupported length
  • Not a string: "prompt" must be a string
aspect_ratioenumOptionalDefaults to 16:9

Shape of the video as width:height.

Allowed values: 16:9, 9:16, 1:1, 4:3, 3:4

Default: 16:9

  • If you leave it out, 16:9 is used, also when the image is portrait.
  • adaptive is not offered by this model.

If the value is wrong

  • A value not in the list: "aspect_ratio" must be one of: [16:9 9:16 1:1 4:3 3:4]
Allowed values:
durationintegerOptional3-15Defaults to 5

Length of the video in seconds, a whole number.

Default: 5

Range: 3–15

  • If you leave it out, 5 is used and billed.
  • Seconds are billed (see Billing), so this is the main lever on the price.

If the value is wrong

  • Outside 3–15, not a whole number, or sent as a string: "duration" is outside its supported range
resolutionenumOptionalDefaults to 720p

Output resolution. 1080p costs more per second than 720p.

Allowed values: 720p, 1080p

Default: 720p

  • Lower case only.

If the value is wrong

  • A value not in the list (for example 480p or 720P): "resolution" must be one of: [720p 1080p]
Allowed values:

Response

The task object. output is null until the task succeeds. Fields marked “while running” disappear once the task finishes.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error