Boreal-H3 Reference to Video Serverless API
Consistent character and product video from reference images.
POST /v2/boreal-h3-reference-to-video · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "prompt": "Handheld phone video of the woman from Image 1 at her wrapping table in the flower studio from Image 3, building the bouquet from Image 2 - coral ranunculus, white anemones and eucalyptus. She snips a stem, tucks it in, then glances up at the camera and says, \"The coral is what pulls it all together.\" Daylight from the shopfront window, shears snipping and paper rustling.",
11 "reference_images": ["https://segmind-resources.s3.amazonaws.com/input/boreal-h3-r2v-ref1-florist.jpg", "https://segmind-resources.s3.amazonaws.com/input/boreal-h3-r2v-ref2-bouquet.jpg", "https://segmind-resources.s3.amazonaws.com/input/boreal-h3-r2v-ref3-studio.jpg"],
12 "resolution": "768p",
13 "duration": 5,
14 "aspect_ratio": "9:16",
15 "prompt_enhancement": "auto",
16}
17job = client.submit_async("boreal-h3-reference-to-video", **payload)
18print(job.request_id) # available immediately
19try:
20 result = job.wait(timeout=900, interval=2.0)
21 print(result["status"]) # COMPLETED
22 print(result.get("output")) # model output (e.g. video URL)
23except InferenceTimeout as e:
24 print("still running:", e.request_id) # re-poll later with this id
25except InferenceFailed as e:
26 print("failed:", e.detail)
27
28# Fast models (<=600s) can use the one-liner instead:
29# result = segmind.run("boreal-h3-reference-to-video", **payload) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "prompt": "Handheld phone video of the woman from Image 1 at her wrapping table in the flower studio from Image 3, building the bouquet from Image 2 - coral ranunculus, white anemones and eucalyptus. She snips a stem, tucks it in, then glances up at the camera and says, \"The coral is what pulls it all together.\" Daylight from the shopfront window, shears snipping and paper rustling.",
11 "reference_images": ["https://segmind-resources.s3.amazonaws.com/input/boreal-h3-r2v-ref1-florist.jpg", "https://segmind-resources.s3.amazonaws.com/input/boreal-h3-r2v-ref2-bouquet.jpg", "https://segmind-resources.s3.amazonaws.com/input/boreal-h3-r2v-ref3-studio.jpg"],
12 "resolution": "768p",
13 "duration": 5,
14 "aspect_ratio": "9:16",
15 "prompt_enhancement": "auto",
16}
17job = client.submit_async("boreal-h3-reference-to-video", **payload)
18print(job.request_id) # available immediately
19try:
20 result = job.wait(timeout=900, interval=2.0)
21 print(result["status"]) # COMPLETED
22 print(result.get("output")) # model output (e.g. video URL)
23except InferenceTimeout as e:
24 print("still running:", e.request_id) # re-poll later with this id
25except InferenceFailed as e:
26 print("failed:", e.detail)
27
28# Fast models (<=600s) can use the one-liner instead:
29# result = segmind.run("boreal-h3-reference-to-video", **payload)API Endpoint
https://api.segmind.com/v1/boreal-h3-reference-to-videoParameters
promptrequiredstringWrite the shot: subject, action, camera, a quoted line for dialogue and named sounds. Reference assets as Image 1, Video 1, Audio 1.
"Image 1 walks through a neon-lit night market, looking around in wonder"aspect_ratiooptionalstringFrame shape: auto, 16:9, 9:16, 1:1, 4:3 or 3:4. Use 9:16 for social; set it explicitly for 1088p with only video references.
"auto""auto""16:9""9:16""1:1""4:3""3:4"durationoptionalintegerClip length in whole seconds, 1 to 15. Default 5; a 15-second request returns about 14.4 seconds.
5Range: 1 - 15prompt_enhancementoptionalstringauto rewrites the prompt for the model and adds latency; none sends it literally for exact, reproducible wording.
"auto""auto""none"reference_audiosoptionalstring[]Up to 3 audio URLs to carry a voice or sound into the clip. Needs at least one image or video reference alongside it.
reference_imagesoptionalstring[]Up to 9 image URLs of your subject, product or scene, named Image 1, Image 2 in the prompt. Clear, well-lit references hold identity and products best.
reference_videosoptionalstring[]Up to 3 video URLs whose motion, camera and framing carry into the output. Use short, relevant clips that match the shot you want.
resolutionoptionalstringOutput resolution: 768p, 1088p or 2k (1440 px short edge). Use 768p to iterate, 1088p or 2k for finished clips.
"768p""768p""1088p""2k"Response Type
Returns: Video
Asynchronous requests (v2)
Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.
- 1
POST /v2/boreal-h3-reference-to-videoSubmit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- A FAILED request is served as HTTP 422 — the body still carries the error detail.
- An unknown or expired request_id returns HTTP 404.
- Results are retained for 1 hour, then expire.
- Content / RAI blocks surface as FAILED, not a separate state.
- Track completion by polling the status endpoint.
Common Error Codes
The API returns standard HTTP status codes. Detailed error messages are provided in the response body.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out