# HappyHorse 1.1

> HappyHorse 1.1 - Reference to Video. Configured Alibaba route; cloned from happy-horse/reference-to-video.

## Overview

- **Endpoint**: `https://api.higgsfield.ai/alibaba/happy-horse/v1.1/reference-to-video`
- **Model ID**: `alibaba/happy-horse/v1.1/reference-to-video`
- **Category**: image2video
- **Kind**: inference
- **Tags**: trending

## Pricing

Public pricing information is not available for this model.

## Authentication

Keep credentials in server-side environment variables. The SDKs accept the same `KEY_ID:KEY_SECRET` value under their documented variable names.

```bash
export HF_CREDENTIALS="YOUR_KEY_ID:YOUR_KEY_SECRET" # TypeScript
export HF_KEY="YOUR_KEY_ID:YOUR_KEY_SECRET"         # Python and cURL
```

The official SDKs configure the authorization header. Keep credentials server-side; the TypeScript SDK blocks browser use.

## API Information

Use `subscribe` to submit the model request and wait for a terminal result. TypeScript performs automatic polling with `withPolling: true`; Python's synchronous `subscribe` call also waits.

### Input Parameters

- **`seed`** (`integer`, _optional_):

- **`prompt`** (`string`, _required_):
  Write your prompt here

- **`duration`** (`integer`, _optional_):
  - Default: `5`

- **`image_urls`** (`list<string>`, _required_):

- **`resolution`** (`string`, _optional_):
  - Default: `"1080p"`
  - Options: `720p`, `1080p`

### Input JSON Schema

```json
{
  "type": "object",
  "title": "Happy horse",
  "required": [
    "image_urls",
    "prompt"
  ],
  "properties": {
    "seed": {
      "type": "integer",
      "maximum": 2147483646,
      "minimum": 1
    },
    "prompt": {
      "type": "string",
      "title": "Prompt",
      "description": "Write your prompt here"
    },
    "duration": {
      "type": "integer",
      "title": "Duration",
      "default": 5,
      "maximum": 15,
      "minimum": 2
    },
    "image_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "title": "Image URL",
        "format": "uri"
      }
    },
    "resolution": {
      "enum": [
        "720p",
        "1080p"
      ],
      "type": "string",
      "default": "1080p"
    }
  }
}
```

### Required Parameters Example

```json
{
  "prompt": "A cinematic scene at sunset",
  "duration": 5,
  "image_urls": [
    "https://example.com/input.jpg"
  ],
  "resolution": "1080p"
}
```

### Output Schema

The shared polling endpoint returns one of the following status shapes:

```json
{
  "title": "RequestStatus",
  "oneOf": [
    {
      "title": "PendingRequestStatus",
      "type": "object",
      "properties": {
        "request_id": {
          "type": "string",
          "format": "uuid"
        },
        "status_url": {
          "type": "string",
          "format": "uri"
        },
        "cancel_url": {
          "type": "string",
          "format": "uri"
        },
        "status": {
          "type": "string",
          "enum": [
            "queued",
            "in_progress",
            "nsfw",
            "canceled"
          ]
        }
      },
      "required": [
        "status",
        "request_id"
      ]
    },
    {
      "title": "FailedRequestStatus",
      "type": "object",
      "properties": {
        "request_id": {
          "type": "string",
          "format": "uuid"
        },
        "status_url": {
          "type": "string",
          "format": "uri"
        },
        "cancel_url": {
          "type": "string",
          "format": "uri"
        },
        "status": {
          "type": "string",
          "const": "failed"
        },
        "error": {
          "type": "string"
        }
      },
      "required": [
        "status",
        "request_id",
        "error"
      ]
    },
    {
      "title": "CompletedRequestStatus",
      "type": "object",
      "properties": {
        "request_id": {
          "type": "string",
          "format": "uuid"
        },
        "status_url": {
          "type": "string",
          "format": "uri"
        },
        "cancel_url": {
          "type": "string",
          "format": "uri"
        },
        "status": {
          "type": "string",
          "const": "completed"
        },
        "video": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            }
          },
          "required": [
            "url"
          ]
        },
        "zip": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            }
          },
          "required": [
            "url"
          ]
        },
        "mov": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            }
          },
          "required": [
            "url"
          ]
        },
        "jsx": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            }
          },
          "required": [
            "url"
          ]
        },
        "fbx": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            }
          },
          "required": [
            "url"
          ]
        },
        "ply": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "format": "uri"
            }
          },
          "required": [
            "url"
          ]
        }
      },
      "required": [
        "status",
        "request_id",
        "video"
      ]
    }
  ]
}
```

## SDK Installation

Install one of the official server-side SDKs:

```bash
npm install @higgsfield/client
# or
pip install higgsfield-client
```

## Usage Examples

### TypeScript

```typescript
import { config, higgsfield } from "@higgsfield/client/v2";

config({
  credentials: process.env.HF_CREDENTIALS,
});

const result = await higgsfield.subscribe(
  "alibaba/happy-horse/v1.1/reference-to-video",
  {
    input: {
      "prompt": "A cinematic scene at sunset",
      "duration": 5,
      "image_urls": [
        "https://example.com/input.jpg"
      ],
      "resolution": "1080p"
    },
    withPolling: true,
  },
);

console.log(result);
```

### Python

```python
import higgsfield_client

result = higgsfield_client.subscribe(
    'alibaba/happy-horse/v1.1/reference-to-video',
    arguments={'prompt': 'A cinematic scene at sunset',
         'duration': 5,
         'image_urls': ['https://example.com/input.jpg'],
         'resolution': '1080p'},
)

print(result)
```

### cURL

```bash
curl --request POST \
  --url 'https://api.higgsfield.ai/alibaba/happy-horse/v1.1/reference-to-video' \
  --header "Authorization: Key $HF_KEY" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "prompt": "A cinematic scene at sunset",
  "duration": 5,
  "image_urls": [
    "https://example.com/input.jpg"
  ],
  "resolution": "1080p"
}
JSON
```

## Additional Documentation

# About

**HappyHorse 1.1** uses the model ID `alibaba/happy-horse/v1.1/reference-to-video`. HappyHorse 1.1 - Reference to Video. Configured Alibaba route; cloned from happy-horse/reference-to-video.

## 1. Calling the API

Send requests to `https://api.higgsfield.ai/alibaba/happy-horse/v1.1/reference-to-video` with a JSON body matching the parameters below.

### Install

Install an official server-side SDK. cURL needs no package.

```bash control=package group=install-typescript variant=npm label=npm when=javascript
npm install @higgsfield/client
```

```bash control=package group=install-python variant=pip label=pip when=python
pip install higgsfield-client
```

### Setup

Keep credentials in server-side environment variables. The SDKs accept the same `KEY_ID:KEY_SECRET` value under their documented variable names.

```bash
export HF_CREDENTIALS="YOUR_KEY_ID:YOUR_KEY_SECRET" # TypeScript
export HF_KEY="YOUR_KEY_ID:YOUR_KEY_SECRET"         # Python and cURL
```

### Request parameters

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `seed` | `integer` | No | `—` | Minimum: 1. Maximum: 2147483646. |
| `prompt` | `string` | Yes | `—` | Prompt. |
| `duration` | `integer` | No | `5` | Duration. Minimum: 2. Maximum: 15. |
| `image_urls` | `array[string]` | Yes | `—` |  |
| `resolution` | `string` | No | `"1080p"` | Options: 720p, 1080p. |

## 2. Authentication

The official SDKs read credentials from the server environment and send the required `Authorization: Key KEY_ID:KEY_SECRET` header.

### API Key

Never expose the secret in browser-side code or commit it to source control. The TypeScript SDK is server-side only. For direct HTTP calls, use:

```http
Authorization: Key $HF_KEY
```

## 3. Queue

`subscribe` submits the asynchronous request and waits for a terminal result. The TypeScript SDK polls automatically when `withPolling: true`; the Python SDK's synchronous `subscribe` call also waits. A completed request returns the generated file in the `video` field.

### Submit and wait

```ts control=language group=submit variant=javascript label=TypeScript
import { config, higgsfield } from "@higgsfield/client/v2";

config({
  credentials: process.env.HF_CREDENTIALS,
});

const result = await higgsfield.subscribe(
  "alibaba/happy-horse/v1.1/reference-to-video",
  {
    input: {
      "prompt": "A cinematic scene at sunset",
      "duration": 5,
      "image_urls": [
        "https://example.com/input.jpg"
      ],
      "resolution": "1080p"
    },
    withPolling: true,
  },
);

console.log(result);
```

```python control=language group=submit variant=python label=Python
import higgsfield_client

result = higgsfield_client.subscribe(
    'alibaba/happy-horse/v1.1/reference-to-video',
    arguments={'prompt': 'A cinematic scene at sunset',
         'duration': 5,
         'image_urls': ['https://example.com/input.jpg'],
         'resolution': '1080p'},
)

print(result)
```

```bash control=language group=submit variant=curl label=cURL
curl --request POST \
  --url 'https://api.higgsfield.ai/alibaba/happy-horse/v1.1/reference-to-video' \
  --header "Authorization: Key $HF_KEY" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "prompt": "A cinematic scene at sunset",
  "duration": 5,
  "image_urls": [
    "https://example.com/input.jpg"
  ],
  "resolution": "1080p"
}
JSON
```

### Explicit lifecycle control

Use the Python SDK when a worker needs explicit status, result, or cancellation control for an existing request. The TypeScript v2 client currently exposes automatic polling through `subscribe`.

```python
import higgsfield_client

request_id = "{request_id}"
status = higgsfield_client.status(request_id=request_id)
result = higgsfield_client.result(request_id=request_id)
higgsfield_client.cancel(request_id=request_id)
```

## Additional Resources

- [Model page](https://console.higgsfield.ai/models/alibaba/happy-horse/v1.1/reference-to-video)
- [This LLM-readable document](https://dash.higgsfield.ai/models/alibaba/happy-horse/v1.1/reference-to-video/llms.txt)