Documentation Index Fetch the complete documentation index at: https://docs.oxen.ai/llms.txt
Use this file to discover all available pages before exploring further.
Try Happy Horse - Reference to Video in the Workbench Run this model interactively, tune parameters, and compare outputs.
Model ID: happyhorse-1.0-r2vHappyHorse 1.0 reference-to-video generates video from a text prompt and up to 9 reference images for character or scene consistency. Output up to 1080P with durations from 3 to 15 seconds and configurable aspect ratio.
Example request Use the Workbench as a request builder: configure parameters for this model in the UI, then open the API tab to copy the exact cURL or Python call. Sync
Async
Async with SSE
This blocks until the video is ready (typically 5-15 minutes). Prefer Async or Async with SSE for anything beyond quick experimentation. See the video generation reference for more details. Minimal
Basic parameters
All parameters
curl -X POST https://hub.oxen.ai/api/ai/videos/generate \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting." }'
curl -X POST https://hub.oxen.ai/api/ai/videos/generate \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting.", "reference_images": [ "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" ] }'
curl -X POST https://hub.oxen.ai/api/ai/videos/generate \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting.", "reference_images": [ "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" ], "aspect_ratio": "16:9", "resolution": "1080P", "duration": 5 }'
See the async queue reference for more details. Minimal
Basic parameters
All parameters
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting." }' | jq -r '.generations[0].generation_id' ) # Poll until the generation reaches a terminal status. while true ; do STATUS = $( curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq -r '.status' ) echo "Status: $STATUS " case $STATUS in succeeded | failed | cancelled ) break ;; esac sleep 5 done # Print the result. curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq .
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting.", "reference_images": [ "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" ] }' | jq -r '.generations[0].generation_id' ) # Poll until the generation reaches a terminal status. while true ; do STATUS = $( curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq -r '.status' ) echo "Status: $STATUS " case $STATUS in succeeded | failed | cancelled ) break ;; esac sleep 5 done # Print the result. curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq .
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting.", "reference_images": [ "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" ], "aspect_ratio": "16:9", "resolution": "1080P", "duration": 5 }' | jq -r '.generations[0].generation_id' ) # Poll until the generation reaches a terminal status. while true ; do STATUS = $( curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq -r '.status' ) echo "Status: $STATUS " case $STATUS in succeeded | failed | cancelled ) break ;; esac sleep 5 done # Print the result. curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq .
See the async queue reference for more details. Minimal
Basic parameters
All parameters
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting." }' | jq -r '.generations[0].generation_id' ) # Stream the SSE channel, grab the data line that follows a # media_generation_completed event for our id, and pretty-print it. curl -sN -H "Authorization: Bearer $OXEN_API_KEY " https://hub.oxen.ai/api/events \ | awk -v id=" $GEN_ID " ' /^event: media_generation_completed$/ { expect=1; next } /^data: / && expect { payload = substr($0, 7) if (index(payload, "\"generation_id\":\"" id "\"")) { print payload; exit } expect = 0 } ' | jq .
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting.", "reference_images": [ "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" ] }' | jq -r '.generations[0].generation_id' ) # Stream the SSE channel, grab the data line that follows a # media_generation_completed event for our id, and pretty-print it. curl -sN -H "Authorization: Bearer $OXEN_API_KEY " https://hub.oxen.ai/api/events \ | awk -v id=" $GEN_ID " ' /^event: media_generation_completed$/ { expect=1; next } /^data: / && expect { payload = substr($0, 7) if (index(payload, "\"generation_id\":\"" id "\"")) { print payload; exit } expect = 0 } ' | jq .
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "happyhorse-1.0-r2v", "prompt": "Image 1 walks through a beautiful garden, cinematic lighting.", "reference_images": [ "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" ], "aspect_ratio": "16:9", "resolution": "1080P", "duration": 5 }' | jq -r '.generations[0].generation_id' ) # Stream the SSE channel, grab the data line that follows a # media_generation_completed event for our id, and pretty-print it. curl -sN -H "Authorization: Bearer $OXEN_API_KEY " https://hub.oxen.ai/api/events \ | awk -v id=" $GEN_ID " ' /^event: media_generation_completed$/ { expect=1; next } /^data: / && expect { payload = substr($0, 7) if (index(payload, "\"generation_id\":\"" id "\"")) { print payload; exit } expect = 0 } ' | jq .
Fetch model details The models endpoint returns the full model object, including its json_request_schema.
curl -H "Authorization: Bearer $OXEN_API_KEY " https://hub.oxen.ai/api/ai/models/happyhorse-1.0-r2v
Request parameters Required parameters Field Type Default Description promptstring"Image 1 walks through a beautiful garden, cinematic lighting."Text prompt describing the desired video. Use ‘Image 1, Image 2, …’ to reference reference_images in order.
Optional parameters Field Type Default Description reference_imagesarray<string>— Array of up to 9 reference image URLs for character/object/scene appearance. Order maps to ‘Image 1’, ‘Image 2’, etc. Formats: JPEG, JPG, PNG. Max 10 MB each. 720p or higher recommended; shorter side must exceed 400 pixels. Reference images should share a similar aspect ratio close to the target video’s aspect ratio. aspect_ratiostring"16:9"Aspect ratio of the generated video. One of: 16:9, 9:16, 1:1, 4:3, 3:4. resolutionstring"1080P"Output video resolution tier. One of: 720P, 1080P. durationinteger5Output video duration in seconds (3-15). Range: 3 – 15. seedinteger— Random seed for reproducibility (0-2147483647). Range: 0 – 2147483647.
