> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.beatapi.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server.

# HappyHorse 1.1

POST https://api.beatapi.io/v1/videos/tasks
Content-Type: application/json

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 itOpens 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 IDsTwo HappyHorse models share this endpoint and accept exactly the same request. The values below come straight from the gateway contract.| Model ID             | `duration` (s) | `resolution`    | `aspect_ratio`                      | Max images | Notes                                                                                                              |
| -------------------- | -------------- | --------------- | ----------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ |
| `happyhorse-1.0`     | 3–15           | `720p`, `1080p` | `16:9`, `9:16`, `1:1`, `4:3`, `3:4` | 9          | The first HappyHorse model. Not on the live model list: create answers 503 with the code `processing_unavailable`. |
| **`happyhorse-1.1`** | 3–15           | `720p`, `1080p` | `16:9`, `9:16`, `1:1`, `4:3`, `3:4` | 9          | Same fields and limits as 1.0.                                                                                     |## Endpoint and authentication`POST https://api.beatapi.io/v1/videos/tasks`Authorization
string
RequiredYour BeatAPI API key, sent as `Bearer <BEATAPI_API_KEY>`. Create keys in the [Dashboard](https://beatapi.io/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`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`.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](/webhooks) for `task.succeeded` and `task.failed`; keep polling as the fallback, because a task stopped by the processing timeout sends no event.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| Mode           | Required inputs                            | Notes                                             |
| -------------- | ------------------------------------------ | ------------------------------------------------- |
| One image      | `model`, `prompt`, `images` (1 link)       | The video is made from this image.                |
| Several images | `model`, `prompt`, `images` (2 to 9 links) | The images are passed to the model in list order. |## Request parametersmodel
string
RequiredThe 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
RequiredWhat 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[]
RequiredThe 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](/quick-guide#upload-an-input-file) 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: 5Length 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:9Shape 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: 720pOutput 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 limitsThe 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 acceptSending 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```bash title="cURL"
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"
}'
``````python title="Python"
import os
import requests

response = requests.post(
    "https://api.beatapi.io/v1/videos/tasks",
    headers={"Authorization": f"Bearer {os.environ['BEATAPI_API_KEY']}"},
    json={
      "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"
    },
    timeout=60,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{response.status_code} {body['error']['code']}: {body['error']['message']}")
task = body["data"]
print(task["id"], task["status"])
``````javascript title="JavaScript"
const response = await fetch('https://api.beatapi.io/v1/videos/tasks', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.BEATAPI_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "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"
  }),
});
const body = await response.json();
if (!response.ok) throw new Error(`${response.status} ${body.error.code}: ${body.error.message}`);
console.log(body.data.id, body.data.status);
```### Image to videoA 5-second 720p portrait clip made from one image.```bash
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 imagesTwo images, passed to the model in list order, as a 10-second 1080p clip.```bash
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.```json
{
  "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
  }
}
```| Field                                  | Type              | Description                                                                                                                              |
| -------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `data.id`                              | `string`          | Task ID: `task_` followed by 32 letters and digits. Use it to poll and to match webhook events.                                          |
| `data.object`                          | `string`          | Always `task`.                                                                                                                           |
| `data.task_kind`                       | `string`          | `image` or `video`.                                                                                                                      |
| `data.capability_id`                   | `string`          | The model ID you sent.                                                                                                                   |
| `data.capability_version`              | `integer`         | Contract version of the model, currently `1`.                                                                                            |
| `data.media_type`                      | `string`          | `image` or `video`.                                                                                                                      |
| `data.model`                           | `string`          | The model ID you sent (same as `capability_id`).                                                                                         |
| `data.status`                          | `string`          | `queued`, `processing`, `succeeded` or `failed`. Only the last two are final.                                                            |
| `data.stage`                           | `string`          | Repeats `status`; kept for older clients.                                                                                                |
| `data.created_at`                      | `integer`         | When the task was created, Unix seconds.                                                                                                 |
| `data.updated_at`                      | `integer`         | Last change, Unix seconds.                                                                                                               |
| `data.completed_at`                    | `integer \| null` | When the task finished, Unix seconds; `null` while it runs.                                                                              |
| `data.poll_after_seconds`              | `integer`         | While running: how long to wait before the next poll (5 for images, 8 for videos).                                                       |
| `data.typical_seconds`                 | `object`          | While running, when enough recent tasks exist: `p50` and `p90` completion times in seconds over the last `window`, from `samples` tasks. |
| `data.output`                          | `object \| null`  | The result; `null` until `status` is `succeeded`. See the output fields below.                                                           |
| `data.usage.credits_reserved`          | `number`          | USD held from your balance when the task was created.                                                                                    |
| `data.usage.credits_charged`           | `number`          | USD this task costs; `0` on a failed task.                                                                                               |
| `data.usage.credits_settled`           | `number`          | USD finally taken; set when the task succeeds, otherwise `0`.                                                                            |
| `data.usage.credits_refunded`          | `number`          | USD returned to your balance; equals the reservation on a failed task once the refund is recorded.                                       |
| `data.usage.billable_duration_seconds` | `integer`         | Video only: the seconds the price is based on. Absent when the model reports no duration.                                                |
| `data.request_id`                      | `string`          | Request ID. Include it when you contact support.                                                                                         |
| `data.error_code`                      | `string \| null`  | Failure code; `null` unless the task failed.                                                                                             |
| `data.error_message`                   | `string \| null`  | What 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`.```json
{
  "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| Field                      | Type       | Description                                                                            |
| -------------------------- | ---------- | -------------------------------------------------------------------------------------- |
| `output.media`             | `object[]` | The generated files; one video for this model.                                         |
| `output.media[].type`      | `string`   | Always `video`.                                                                        |
| `output.media[].url`       | `string`   | HTTPS link to the stored video. Download and keep it; no retention period is promised. |
| `output.media[].mime_type` | `string`   | `video/mp4`.                                                                           |
| `output.r2_url`            | `string`   | The video URL again, for older clients. Read `media` instead.                          |### Failed taskA 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.```json
{
  "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."
  }
}
```| Field                | Type      | Description                                                                                                                                                                                                            |
| -------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data.error_code`    | `string`  | One 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](/errors). |
| `data.error_message` | `string`  | A sentence that names the problem and the fix.                                                                                                                                                                         |
| `data.retryable`     | `boolean` | Present only on a failed task: `true` when the same request can succeed if you send it again.                                                                                                                          |
| `data.usage`         | `object`  | Once 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 exampleCreate 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`.```python
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](https://beatapi.io/pricing). An account with a negotiated discount pays less; `data.usage` on the task always shows the amount actually charged.| Option        | List price (USD) |
| ------------- | ---------------- |
| 8 sec · 720p  | \$0.9            |
| 8 sec · 1080p | \$1.16           |## Common errors| Error or symptom                                                        | Cause                                                                                                    | Fix                                                                                                        |
| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| 400 `"images" is required`                                              | No `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 items`                                  | More than 9 image links.                                                                                 | Send at most 9.                                                                                            |
| 400 `"duration" is outside its supported range`                         | Below 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.1` | This model takes images only; reference videos, reference audio and other video fields are refused.      | Remove the field.                                                                                          |
| Task `failed` with `bad_request`                                        | An 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_violation`                           | The 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_credits`                                              | The 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 glanceErrors 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](/errors).```json
{
  "error": {
    "code": "bad_request",
    "message": "\"prompt\" is required",
    "retryable": false,
    "request_id": "req_5f0c2a9e4b7d4e31"
  }
}
```| HTTP status | `error.code`                                                                                  | What to do                                                                                                            |
| ----------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| 400         | `bad_request`, `content_policy_violation`                                                     | Fix the request; the message names the field. Do not retry unchanged.                                                 |
| 401         | `missing_api_key`, `invalid_api_key` (older clients may see `unauthorized`)                   | Send a valid key as `Authorization: Bearer <key>`.                                                                    |
| 402         | `insufficient_credits`                                                                        | Top up, or raise the key’s quota, then send it again.                                                                 |
| 403         | `forbidden`                                                                                   | The key or account may not use this model (for example, free credit only covers some models). Do not retry unchanged. |
| 404         | `not_found`                                                                                   | On `GET /v1/tasks/{task_id}`: the task does not exist for this key’s account. Check the ID.                           |
| 409         | `idempotency_conflict`                                                                        | Use a new `Idempotency-Key`, or wait for the first request with this key to finish.                                   |
| 429         | `rate_limit_exceeded`                                                                         | Wait `Retry-After` seconds (also `error.retry_after_seconds`), then retry.                                            |
| 500         | `internal_error`                                                                              | Retry with backoff; contact support with `request_id` if it continues.                                                |
| 503         | `processing_unavailable`, `processing_timeout`, `processing_failed`, `result_transfer_failed` | Nothing was charged. Retry with exponential backoff.                                                                  |

Reference: https://docs.beatapi.io/api-reference/video-api/happyhorse-1-1

## Authentication

- `Authorization` header (bearer token, required) — Send your API key as `Authorization: Bearer <BEATAPI_API_KEY>`.

## Servers

- `https://api.beatapi.io` (Direct, default)
- `https://api.beatapi.io` (API)

## Request

### Headers

- `Idempotency-Key` (string, optional) — 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.

### Body (application/json)

This endpoint expects a HappyHorse11VideoRequest.

- `images` (list of 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](/quick-guide#upload-an-input-file) 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`
- `model` (enum, 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`
  - Allowed values: `happyhorse-1.1`
- `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`
- `aspect_ratio` (enum, optional, default: 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: `16:9`, `9:16`, `1:1`, `4:3`, `3:4`
- `duration` (integer, optional, default: 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`
- `resolution` (enum, optional, default: 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: `720p`, `1080p`

## Response

### 201

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

- `map from string to any`

## Errors

### 400 Bad Request Error

`bad_request`, `content_policy_violation` Fix the request; the message names the field. Do not retry unchanged.

- `map from string to any`

### 401 Unauthorized Error

`missing_api_key`, `invalid_api_key` (older clients may see `unauthorized`) Send a valid key as `Authorization: Bearer <key>`.

- `map from string to any`

### 402 Payment Required Error

`insufficient_credits` Top up, or raise the key’s quota, then send it again.

- `map from string to any`

### 403 Forbidden Error

`forbidden` The key or account may not use this model (for example, free credit only covers some models). Do not retry unchanged.

- `map from string to any`

### 409 Conflict Error

`idempotency_conflict` Use a new `Idempotency-Key`, or wait for the first request with this key to finish.

- `map from string to any`

### 429 Too Many Requests Error

`rate_limit_exceeded` Wait `Retry-After` seconds (also `error.retry_after_seconds`), then retry.

- `map from string to any`

### 500 Internal Server Error

`internal_error` Retry with backoff; contact support with `request_id` if it continues.

- `map from string to any`

### 503 Service Unavailable Error

`processing_unavailable`, `processing_timeout`, `processing_failed`, `result_transfer_failed` Nothing was charged. Retry with exponential backoff.

- `map from string to any`

## Examples

### Image to video

**Request**

```json
{
  "images": [
    "https://media.beatapi.io/samples/neon-singer.png"
  ],
  "model": "happyhorse-1.1",
  "prompt": "The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights",
  "aspect_ratio": "9:16",
  "duration": 5,
  "resolution": "720p"
}
```

**Response**

```json
{
  "data": {
    "capability_id": "happyhorse-1.1",
    "capability_version": 1,
    "completed_at": null,
    "created_at": 1791993600,
    "error_code": null,
    "error_message": null,
    "id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
    "media_type": "video",
    "model": "happyhorse-1.1",
    "object": "task",
    "output": null,
    "poll_after_seconds": 8,
    "request_id": "req_5f0c2a9e4b7d4e31",
    "stage": "queued",
    "status": "queued",
    "task_kind": "video",
    "updated_at": 1791993600,
    "usage": {
      "billable_duration_seconds": 5,
      "credits_charged": 0.5625,
      "credits_refunded": 0,
      "credits_reserved": 0.5625,
      "credits_settled": 0
    }
  }
}
```

**SDK Code**

```python Image to video
import requests

url = "https://api.beatapi.io/v1/videos/tasks"

payload = {
    "images": ["https://media.beatapi.io/samples/neon-singer.png"],
    "model": "happyhorse-1.1",
    "prompt": "The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights",
    "aspect_ratio": "9:16",
    "duration": 5,
    "resolution": "720p"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Image to video
const url = 'https://api.beatapi.io/v1/videos/tasks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"images":["https://media.beatapi.io/samples/neon-singer.png"],"model":"happyhorse-1.1","prompt":"The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights","aspect_ratio":"9:16","duration":5,"resolution":"720p"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Image to video
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beatapi.io/v1/videos/tasks"

	payload := strings.NewReader("{\n  \"images\": [\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights\",\n  \"aspect_ratio\": \"9:16\",\n  \"duration\": 5,\n  \"resolution\": \"720p\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Image to video
require 'uri'
require 'net/http'

url = URI("https://api.beatapi.io/v1/videos/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"images\": [\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights\",\n  \"aspect_ratio\": \"9:16\",\n  \"duration\": 5,\n  \"resolution\": \"720p\"\n}"

response = http.request(request)
puts response.read_body
```

```java Image to video
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.beatapi.io/v1/videos/tasks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"images\": [\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights\",\n  \"aspect_ratio\": \"9:16\",\n  \"duration\": 5,\n  \"resolution\": \"720p\"\n}")
  .asString();
```

```php Image to video
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beatapi.io/v1/videos/tasks', [
  'body' => '{
  "images": [
    "https://media.beatapi.io/samples/neon-singer.png"
  ],
  "model": "happyhorse-1.1",
  "prompt": "The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights",
  "aspect_ratio": "9:16",
  "duration": 5,
  "resolution": "720p"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Image to video
using RestSharp;

var client = new RestClient("https://api.beatapi.io/v1/videos/tasks");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"images\": [\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights\",\n  \"aspect_ratio\": \"9:16\",\n  \"duration\": 5,\n  \"resolution\": \"720p\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Image to video
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "images": ["https://media.beatapi.io/samples/neon-singer.png"],
  "model": "happyhorse-1.1",
  "prompt": "The singer turns toward the camera and smiles, hair moving in the breeze, warm spotlights",
  "aspect_ratio": "9:16",
  "duration": 5,
  "resolution": "720p"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beatapi.io/v1/videos/tasks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Several images

**Request**

```json
{
  "images": [
    "https://media.beatapi.io/samples/smart-bottle.png",
    "https://media.beatapi.io/samples/neon-singer.png"
  ],
  "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",
  "aspect_ratio": "16:9",
  "duration": 10,
  "resolution": "1080p"
}
```

**Response**

```json
{
  "data": {
    "capability_id": "happyhorse-1.1",
    "capability_version": 1,
    "completed_at": null,
    "created_at": 1791993600,
    "error_code": null,
    "error_message": null,
    "id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
    "media_type": "video",
    "model": "happyhorse-1.1",
    "object": "task",
    "output": null,
    "poll_after_seconds": 8,
    "request_id": "req_5f0c2a9e4b7d4e31",
    "stage": "queued",
    "status": "queued",
    "task_kind": "video",
    "updated_at": 1791993600
  }
}
```

**SDK Code**

```python Several images
import requests

url = "https://api.beatapi.io/v1/videos/tasks"

payload = {
    "images": ["https://media.beatapi.io/samples/smart-bottle.png", "https://media.beatapi.io/samples/neon-singer.png"],
    "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",
    "aspect_ratio": "16:9",
    "duration": 10,
    "resolution": "1080p"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Several images
const url = 'https://api.beatapi.io/v1/videos/tasks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"images":["https://media.beatapi.io/samples/smart-bottle.png","https://media.beatapi.io/samples/neon-singer.png"],"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","aspect_ratio":"16:9","duration":10,"resolution":"1080p"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Several images
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beatapi.io/v1/videos/tasks"

	payload := strings.NewReader("{\n  \"images\": [\n    \"https://media.beatapi.io/samples/smart-bottle.png\",\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The camera pushes in from the bottle on the table to the singer on a neon stage in one continuous move\",\n  \"aspect_ratio\": \"16:9\",\n  \"duration\": 10,\n  \"resolution\": \"1080p\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Several images
require 'uri'
require 'net/http'

url = URI("https://api.beatapi.io/v1/videos/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"images\": [\n    \"https://media.beatapi.io/samples/smart-bottle.png\",\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The camera pushes in from the bottle on the table to the singer on a neon stage in one continuous move\",\n  \"aspect_ratio\": \"16:9\",\n  \"duration\": 10,\n  \"resolution\": \"1080p\"\n}"

response = http.request(request)
puts response.read_body
```

```java Several images
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.beatapi.io/v1/videos/tasks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"images\": [\n    \"https://media.beatapi.io/samples/smart-bottle.png\",\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The camera pushes in from the bottle on the table to the singer on a neon stage in one continuous move\",\n  \"aspect_ratio\": \"16:9\",\n  \"duration\": 10,\n  \"resolution\": \"1080p\"\n}")
  .asString();
```

```php Several images
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beatapi.io/v1/videos/tasks', [
  'body' => '{
  "images": [
    "https://media.beatapi.io/samples/smart-bottle.png",
    "https://media.beatapi.io/samples/neon-singer.png"
  ],
  "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",
  "aspect_ratio": "16:9",
  "duration": 10,
  "resolution": "1080p"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Several images
using RestSharp;

var client = new RestClient("https://api.beatapi.io/v1/videos/tasks");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"images\": [\n    \"https://media.beatapi.io/samples/smart-bottle.png\",\n    \"https://media.beatapi.io/samples/neon-singer.png\"\n  ],\n  \"model\": \"happyhorse-1.1\",\n  \"prompt\": \"The camera pushes in from the bottle on the table to the singer on a neon stage in one continuous move\",\n  \"aspect_ratio\": \"16:9\",\n  \"duration\": 10,\n  \"resolution\": \"1080p\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Several images
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "images": ["https://media.beatapi.io/samples/smart-bottle.png", "https://media.beatapi.io/samples/neon-singer.png"],
  "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",
  "aspect_ratio": "16:9",
  "duration": 10,
  "resolution": "1080p"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beatapi.io/v1/videos/tasks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```