Docs

Running a model

AlibabaText to video

Alibaba HappyHorse-1.0

Text-to-video and image-to-video model with 1080p output and short-form clip control

POSTauray-serverless/alibaba/happyhorse-1-0
openapi.jsonllms.txt

One of Auray's catalogue models: the same key, the same credits, the same job lifecycle as every other address.

Its request shape is published below. Whether it runs right now is GET /v1/catalogue's word, with no key needed: its addresses say connected for an address that runs, and a submit to any other is refused before anything is charged — described answers 501 model_not_connected, paused 503 model_disabled.

Category text-to-video · Scope video:write (or external:write on an older key) · Price Credits per second of output (counted as duration): 12.3 for resolution=720p; 24.2 for resolution=1080p. Each band has its own least and most a request is counted at. Plus 1500 credits when the request sends inputs.video (counted as any:inputs.video). Quoted when you submit, at the most the request can cost; the charge settles to what the job cost and never above the quote. The submit's answer carries the quote as credits_quoted, and credits_charged says what has been taken.

#Input

FieldTypeRequiredDefaultDescription
inputsobjectno—
inputs.videostringno—Video input (an http(s) URL; upload a local file first and send its read URL). Source video for prompt-based editing. Dimensions are inherited from the input video. A URL.
positivePromptstringyes, by a rule—Text prompt describing elements to include in the generated output. Documented range: 1 to 2,500 characters.
widthintegerno1920Width of the generated media in pixels.
heightintegerno1080Height of the generated media in pixels.
resolutionstringno"1080p"Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input. One of "720p", "1080p".
durationintegerno5Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps). Documented range: 3 to 15.
seedintegerno—Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range. Documented range: 0 to 2,147,483,647.
settingsobjectno—
settings.audiostringno"auto"Controls audio handling for video editing. One of "auto", "origin".
outputTypestringno"URL"Video output type. One of "URL".
outputFormatstringno"MP4"Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities. - `JPG`: Best for photorealistic images with smaller file sizes (no transparency). - `PNG`: Lossless compression, supports high quality and transparency (alpha channel). - `WEBP`: Modern format providing superior compression and transparency support. - `MP4`: Widely supported video container (H.264), recommended for general use. - `WEBM`: Optimized for web delivery. - `MOV`: QuickTime format, common in professional workflows (Apple ecosystem). - `GIF`: Animated image format (no audio), suitable for short loops or previews. - `MP3`: Compressed audio, smaller file size. - `WAV`: Uncompressed, high-quality audio. - `FLAC`: Lossless compression. - `OGG`: Open-source compressed audio format (Vorbis codec). - `SVG`: Scalable Vector Graphics. - `TIFF`: High-quality output supporting layers. - `GLB`: Binary glTF format for 3D models, including geometry, textures, and PBR materials. > [!NOTE] > **Transparency**: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., `PNG`, `WEBP`, `TIFF`). `JPG` does not support transparency. One of "MP4", "WEBM", "MOV".
outputQualityintegerno95Compression quality of the output. Higher values preserve quality but increase file size. Documented range: 20 to 99.
idempotency_keystringno—Your own name for this request. Send the same one twice and the second call is answered with the first request rather than charged again. Idempotency-Key: as a header is accepted as an alias — that is the spelling a retrying proxy replays, and the one to use when running a model on auray.run, where a request that outlives its connection is answered 504 and recovered by replay. Omit it and the platform mints one. 1 to 64 characters.

#Rules

Across fields, as the model's documentation states them. Each is judged before anything is charged — warned with a Deprecation header until enforcement starts — and listed as JSON Schema under x-auray-rules in the openapi.json.

  • Send height whenever width is sent. Send width whenever height is sent.
  • When inputs.video is sent, do not send a request where width is sent, or where height is sent. Otherwise, width and height are required.
  • Do not send resolution together with width or height.
  • When inputs.video is sent, do not send a request where width is sent, or where height is sent.
  • When width is sent or height is sent, width and height must be one of these: 720p (16:9): width 1280, height 720; 720p (9:16): width 720, height 1280; 720p (1:1): width 960, height 960; 720p (~4:3): width 1088, height 832; 720p (~3:4): width 832, height 1088; 1080p (16:9): width 1920, height 1080; 1080p (9:16): width 1080, height 1920; 1080p (1:1): width 1440, height 1440; 1080p (~4:3): width 1632, height 1248; 1080p (~3:4): width 1248, height 1632.
  • When resolution is sent, inputs.video is required.
  • positivePrompt is required.
  • When settings.audio is sent, inputs.video is required.

#Example

curl -X POST https://queue.auray.run/auray-serverless/alibaba/happyhorse-1-0 \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "width": 1920,
  "height": 1080,
  "positivePrompt": "a brass orrery on a walnut desk, morning light from a window to the left"
}'

The same body on https://auray.run runs synchronously and answers the result — unless it usually takes longer than a run may hold its connection, which is refused 400 model_not_synchronous before anything is charged. Options — ?webhook=, ?wait=, priority and timeout headers — are on Submit a request.

#Machine contracts

  • openapi.json — this page as an OpenAPI 3.1 document, public.
  • llms.txt — the same, written for an agent.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close