Get API

Happyhorse 1.1 Reference To Video

Happyhorse 1.1 Reference To Video is available in the Business API catalog.

alibaba/happyhorse-1.1/reference-to-video

Capabilities

Best for

  • •Cinematic text-to-video shots
  • •Short social and ad clips
  • •Consistent multi-shot sequences
  • •Look-dev and style exploration

Not for

  • •Frame-exact rotoscoping
  • •Feature-length renders
  • •Pixel-perfect compositing
  • •Precise on-screen text

Authentication

api key header

The Pika API uses API keys to authenticate requests. Send your key in the X-API-Key header. Your API key is a secret. Don't expose it in browsers or other client-side code. Instead, call the API from your server. The signed-in playground uses a portal session and never sends your API key.

header
X-API-Key: YOUR_API_KEY

Endpoint

asynchronous · poll for the result

POSThttps://api.dev.pika.art/v1/media/alibaba/happyhorse-1.1/reference-to-videogenerate endpoint
GEThttps://api.dev.pika.art/v1/media/jobs/{request_id}poll until completed
GEThttps://api.dev.pika.art/v1/media/jobs/{request_id}/contentget the result URL

Reference Uploads

media inputs

Media inputs accept any public URL. To use a local file, POST its content_type and size_bytes to /v1/media/uploads, PUT the file to the returned upload_url, then pass the url.

upload
# 1. Request a presigned upload URL. Send the file's content
#    type and its exact size in bytes.
curl -X POST https://api.dev.pika.art/v1/media/uploads \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content_type": "image/png", "size_bytes": 12345}'


# The response returns two URLs:
#   upload_url: a temporary URL to upload the file to. Expires in 5 minutes.
#   url:        the permanent Pika URL. Pass it to the model as the input.
# {
#   "upload_url": "https://upload.r2.pika.art/...?X-Amz-Signature=...",
#   "url": "https://cdn.pika.art/v2/media/uploads/org_abc/9f8e7d.png"
# }


# 2. Upload the file to upload_url, then pass url to the model.
curl -X PUT "<upload_url>" \
  -H "Content-Type: image/png" \
  --data-binary @input.png

Generate

POST /v1/media/alibaba/happyhorse-1.1/reference-to-video

Request

curl -X POST https://api.dev.pika.art/v1/media/alibaba/happyhorse-1.1/reference-to-video \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prompt": "Use P1 and P2 as the boy reference and P3 as the background/world reference. A boy walks alone in the center of the amusement park street. Keep his same face, messy brown hair, pale skin, tired reddish eyes, white shirt, white overalls, white sneakers, slim body, and the small teddy bear in his left hand. The style is soft pastel, 3D cel-shaded, thick paint, with oil painting texture and visible brush strokes. He walks slowly and sadly with his head slightly lowered, and the teddy bear swings gently. Keep the same character, outfit, lighting, and location in every shot. The video is 8 seconds with 4 shots: back wide shot, side tracking shot, close-up of walking feet and teddy bear, and side close-up of his face. Keep the walking speed and direction consistent.",
  "resolution": "1080P",
  "ratio": "16:9",
  "duration": 8,
  "watermark": false,
  "reference_image_urls": [
    "https://cdn.pika.art/v2/files/agent/1d72c4e5-5c1e-4fea-a953-b57c8f1949cf/79f4690cb957f2ad5deb95733c361ea9756db8bc0cbe667734af836dea4fb8fe",
    "https://cdn.pika.art/v2/files/agent/1d72c4e5-5c1e-4fea-a953-b57c8f1949cf/dca4e15459416ca15b4caff267956e5f5c9f66413ffe8d6374a299b6b15de84e",
    "https://cdn.pika.art/v2/files/agent/1d72c4e5-5c1e-4fea-a953-b57c8f1949cf/bcea7de1d56e0db8853d42396c289883c94926ac3684282ec0b15e9b7a3c83ce"
  ]
}'

Response

{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "queued"
}

Request body

promptstringrequired
Prompt
resolutionenum
Resolution
ratioenum
Ratio
durationinteger3 – 15default: 5
Duration
watermarkbooleandefault: false
Watermark
seedinteger
Seed
reference_image_urlsstring[]required
Reference Image Urls

Accepted values

resolution
ratio

Input modes

Reference image urlsreference_image_urls

Use a public URL directly, or POST { content_type, size_bytes } to /v1/media/uploads, PUT the image to the returned upload_url with the returned headers, then pass the url.

Returns

Returns a job object with status , not the final output. Store the id from the response and poll the job until it completes.

Poll status

GET /v1/media/jobs/{request_id}

Request

curl https://api.dev.pika.art/v1/media/jobs/{request_id} \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "running"
}

Poll the job by id until it reaches a terminal state: completed or failed.

The job object

idstring
Unique identifier for the job.
statusenum
The status of the job.One of:
object
The generation output. Present once the job completes.
errorstring
If the job failed, the reason for the failure.

Get result

GET /v1/media/jobs/{request_id}/content

Request

curl https://api.dev.pika.art/v1/media/jobs/{request_id}/content \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "url": "https://api.dev.pika.art/v1/files/video_8f3a2c91.mp4"
}

Once the job completes, fetch a download URL for the generated media.

Returns

urlstring
Download URL for the generated file.

Errors

shared across calls

Errors use conventional HTTP status codes with a JSON body of the shape {"message": "..."}. Validation failures return 422 with a message naming the offending field. Submit rejections after the job row exists (balance, rate limit) return the failed job envelope — branch on error.code.

StatusWhenBody
401 UnauthorizedThe API key is missing or invalid.{"message":"Invalid API key"}
403 ForbiddenAn inactive key is rejected with a `{"message"}` body. A submit that the org balance or postpaid cycle limit cannot cover is rejected after the job row exists and returns the failed job envelope.{"id":"media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0","status":"failed","error":{"code":"insufficient_balance","message":"Insufficient org balance"}}
404 Not FoundNo job with that id exists in your org, or the media path names an unknown vendor/model/function.{"message":"media job not found"}
409 ConflictThe result was requested before the job completed, or an Idempotency-Key header was reused with a different body.{"message":"media job is not ready"}
422 Unprocessable EntityThe request body failed validation: an invalid enum value, a missing required field, a wrong type, or malformed JSON. The JSON message names the offending field. A schema-valid parameter combination that cannot be priced instead fails after job creation and returns the failed job envelope with error code `invalid_input`.{"message":"duration: Input should be less than or equal to 15"}
429 Too Many RequestsOrg limit reached: requests per minute or day, or concurrent jobs. Returned as the failed job envelope; check the Retry-After header and retry with a fresh Idempotency-Key.{"id":"media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0","status":"failed","error":{"code":"rate_limited","message":"rate limit exceeded: rpm"}}
503 Service UnavailableThe model rail or a backend dependency is temporarily unavailable. Returned as the failed job envelope; retry with backoff and a fresh Idempotency-Key.{"id":"media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0","status":"failed","error":{"code":"provider_unavailable","message":"media dispatch unavailable"}}

Pricing

only successful runs are charged

TierPrice
720p$0.098 / second
1080p$0.13 / second

Per-model pricing

Transparent, usage-based rates for every Alibaba model.

Happyhorse 1.1 Image To Video

Video

Image to Video

720p$0.098 / sec
1080p$0.126 / sec

Reference to VideoCurrent

720p$0.098 / sec
1080p$0.126 / sec

Text to Video

720p$0.098 / sec
1080p$0.126 / sec

Happyhorse 1.0

Video

Image to Video

720p$0.098 / sec
1080p$0.168 / sec

Reference to Video

720p$0.098 / sec
1080p$0.168 / sec

Text to Video

720p$0.098 / sec
1080p$0.168 / sec

Video to Video

720p$0.098 / sec
1080p$0.168 / sec

Join theclub

Get StartedContact Sales