# HappyHorse-1.0 API

> HappyHorse-1.0 — high-quality AI video generation.

- **Provider**: Alibaba
- **Model id**: `happyhorse-video-edit`
- **Modality**: video
- **Price**: 14–24 credits /sec

## Overview

HappyHorse-1.0 is called in two steps: create a generation task, then poll the task until the result is ready.

## Authentication

All requests require a Bearer Token in the request header:

```
Authorization: Bearer YOUR_API_KEY
```

## Create Task

`POST https://you.bot/api/v1/generate`

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| modelId | string | Yes | Model id: `happyhorse-video-edit` |
| input | object | Yes | Input parameters object (see below) |
| callbackUrl | string | No | https URL we POST the finished task to. Signed with `X-Webhook-Signature` once you create a webhook signing key in Dashboard → Settings |

### input object parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| prompt | string | Yes | Required edit instruction describing the intended change (e.g., style transfer / local replacement). Max 5,000 non‑Chinese characters or 2,500 Chinese characters; extra content is truncated. Max 5000 characters. (example: Restyle the clip into a hand-painted watercolor dreamscape where every surface ripples like wet paint, drifting soap bubbles catch the light and a soft golden… — full value in the request example) |
| video_url | string | Yes | Input video URL list. Exactly one video is required. Duration: 3–60s. Resolution: long side ≤ 2160px, short side ≥ 320px. Aspect ratio: 1:2.5 to 2.5:1. Frame rate: > 8 fps. (image URL) |
| reference_image | string[] | No | Optional reference image URL list (0–5). JPEG/JPG/PNG/WEBP, up to 10MB each. Minimum resolution: width and height ≥ 300px. Aspect ratio: 1:2.5 to 2.5:1. (image URL) |
| resolution | string | No | Output video resolution. Valid values: 720P, 1080P (default). (options: 720p \| 1080p) (default: 1080p) |
| audio_setting | string | No | Audio handling strategy for the output video. (options: auto \| origin) (default: auto) |
| seed | number | No | Random seed. Range: [0, 2147483647]. If not specified, the system generates a seed automatically. Fixing the seed can improve reproducibility, but results may still vary due to the model’s stochasticity. |

### Request example

```json
{
  "modelId": "happyhorse-video-edit",
  "input": {
    "prompt": "Restyle the clip into a hand-painted watercolor dreamscape where every surface ripples like wet paint, drifting soap bubbles catch the light and a soft golden glow washes over everything, keeping the original motion intact.",
    "video_url": "https://you.bot/examples/gemini-omni.mp4",
    "reference_image": [
      "https://you.bot/examples/grok-imagine-text-to-image.jpg"
    ],
    "resolution": "720p",
    "audio_setting": "auto",
    "seed": 1
  }
}
```

### Response example

```json
{
  "taskId": "281e5b0…f39b9",
  "creditsCharged": 70
}
```

## Query Task

`GET https://you.bot/api/v1/task/{taskId}?model=happyhorse-video-edit`

When `state` is `success`, the output is in `resultUrls`: `{ "state": "success", "resultUrls": [ ... ] }`. (Text models return inline in the create response.)

## Error Codes

| Code | Description |
|------|-------------|
| 200 | Request successful |
| 400 | Invalid request parameters |
| 401 | Authentication failed — check API Key |
| 402 | Insufficient account balance |
| 403 | IP not allowed for this key, or the key is restricted to other models |
| 404 | Task not found, or it has expired |
| 409 | Duplicate request — an identical submit arrived moments ago. Nothing was charged; retry is safe |
| 413 | Payload too large — see the character and file-size limits for this model |
| 429 | Rate limit exceeded — retry after the Retry-After header |
| 500 | Internal server error |
| 504 | Upstream timed out — nothing was delivered; retry is safe |
